ip.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016 Alexander Aring <aar@pengutronix.de>
3  * Freie Universit├Ąt Berlin
4  * HAW Hamburg
5  * Kaspar Schleiser <kaspar@schleiser.de>
6  *
7  * This file is subject to the terms and conditions of the GNU Lesser
8  * General Public License v2.1. See the file LICENSE in the top level
9  * directory for more details.
10  */
11 
268 #ifndef NET_SOCK_IP_H
269 #define NET_SOCK_IP_H
270 
271 #include <assert.h>
272 #include <stdint.h>
273 #include <stdlib.h>
274 #include <sys/types.h>
275 
276 /* net/sock/async/types.h included by net/sock.h needs to re-typedef the
277  * `sock_ip_t` to prevent cyclic includes */
278 #if defined (__clang__)
279 # pragma clang diagnostic push
280 # pragma clang diagnostic ignored "-Wtypedef-redefinition"
281 #endif
282 
283 #include "net/sock.h"
284 
285 #ifdef __cplusplus
286 extern "C" {
287 #endif
288 
295 typedef struct sock_ip sock_ip_t;
296 
297 #if defined (__clang__)
298 # pragma clang diagnostic pop
299 #endif
300 
343 int sock_ip_create(sock_ip_t *sock, const sock_ip_ep_t *local,
344  const sock_ip_ep_t *remote, uint8_t proto, uint16_t flags);
345 
353 void sock_ip_close(sock_ip_t *sock);
354 
374 
394 
426 ssize_t sock_ip_recv(sock_ip_t *sock, void *data, size_t max_len,
427  uint32_t timeout, sock_ip_ep_t *remote);
428 
471 ssize_t sock_ip_recv_buf(sock_ip_t *sock, void **data, void **buf_ctx,
472  uint32_t timeout, sock_ip_ep_t *remote);
473 
506 ssize_t sock_ip_send(sock_ip_t *sock, const void *data, size_t len,
507  uint8_t proto, const sock_ip_ep_t *remote);
508 
509 #include "sock_types.h"
510 
511 #ifdef __cplusplus
512 }
513 #endif
514 
515 #endif /* NET_SOCK_IP_H */
516 
void sock_ip_close(sock_ip_t *sock)
Closes a raw IPv4/IPv6 sock object.
Raw IP sock type.
Definition: sock_types.h:91
int sock_ip_get_remote(sock_ip_t *sock, sock_ip_ep_t *ep)
Gets the remote end point of a raw IPv4/IPv6 sock object.
int sock_ip_create(sock_ip_t *sock, const sock_ip_ep_t *local, const sock_ip_ep_t *remote, uint8_t proto, uint16_t flags)
Creates a new raw IPv4/IPv6 sock object.
POSIX.1-2008 compliant version of the assert macro.
Abstract IP end point and end point for a raw IP sock object.
Definition: sock.h:176
ssize_t sock_ip_recv_buf(sock_ip_t *sock, void **data, void **buf_ctx, uint32_t timeout, sock_ip_ep_t *remote)
Provides stack-internal buffer space containing an IPv4/IPv6 message from remote end point...
Common sock API definitions.
uint16_t flags
option flags
Definition: sock_types.h:105
sock_ip_ep_t remote
remote end-point
Definition: sock_types.h:104
ssize_t sock_ip_send(sock_ip_t *sock, const void *data, size_t len, uint8_t proto, const sock_ip_ep_t *remote)
Sends a message over IPv4/IPv6 to remote end point.
ssize_t sock_ip_recv(sock_ip_t *sock, void *data, size_t max_len, uint32_t timeout, sock_ip_ep_t *remote)
Receives a message over IPv4/IPv6 from remote end point.
stdlib.h wrapper for MSP430
sock_ip_ep_t local
local end-point
Definition: sock_types.h:103
int sock_ip_get_local(sock_ip_t *sock, sock_ip_ep_t *ep)
Gets the local end point of a raw IPv4/IPv6 sock object.