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 <stdint.h>
272 #include <stdlib.h>
273 #include <sys/types.h>
274 
275 /* net/sock/async/types.h included by net/sock.h needs to re-typedef the
276  * `sock_ip_t` to prevent cyclic includes */
277 #if defined (__clang__)
278 # pragma clang diagnostic push
279 # pragma clang diagnostic ignored "-Wtypedef-redefinition"
280 #endif
281 
282 #include "net/sock.h"
283 
284 #ifdef __cplusplus
285 extern "C" {
286 #endif
287 
294 typedef struct sock_ip sock_ip_t;
295 
296 #if defined (__clang__)
297 # pragma clang diagnostic pop
298 #endif
299 
303 typedef struct {
304 #if defined(MODULE_SOCK_AUX_LOCAL) || defined(DOXYGEN)
311 #endif /* MODULE_SOCK_AUX_ENDPOINT */
312 #if defined(MODULE_SOCK_AUX_TIMESTAMP) || defined(DOXYGEN)
318  uint64_t timestamp;
319 #endif /* MODULE_SOCK_AUX_TIMESTAP */
320 #if defined(MODULE_SOCK_AUX_RSSI) || defined(DOXYGEN)
326  int16_t rssi;
327 #endif /* MODULE_SOCK_AUX_RSSI */
330 
334 typedef struct {
335 #if defined(MODULE_SOCK_AUX_TIMESTAMP) || defined(DOXYGEN)
348  uint64_t timestamp;
349 #endif /* MODULE_SOCK_AUX_TIMESTAP*/
352 
395 int sock_ip_create(sock_ip_t *sock, const sock_ip_ep_t *local,
396  const sock_ip_ep_t *remote, uint8_t proto, uint16_t flags);
397 
406 
426 
446 
480 ssize_t sock_ip_recv_aux(sock_ip_t *sock, void *data, size_t max_len,
481  uint32_t timeout, sock_ip_ep_t *remote,
482  sock_ip_aux_rx_t *aux);
483 
515 static inline ssize_t sock_ip_recv(sock_ip_t *sock, void *data, size_t max_len,
516  uint32_t timeout, sock_ip_ep_t *remote)
517 {
518  return sock_ip_recv_aux(sock, data, max_len, timeout, remote, NULL);
519 }
520 
565 ssize_t sock_ip_recv_buf_aux(sock_ip_t *sock, void **data, void **buf_ctx,
566  uint32_t timeout, sock_ip_ep_t *remote,
567  sock_ip_aux_rx_t *aux);
568 
611 static inline ssize_t sock_ip_recv_buf(sock_ip_t *sock,
612  void **data, void **buf_ctx,
613  uint32_t timeout, sock_ip_ep_t *remote)
614 {
615  return sock_ip_recv_buf_aux(sock, data, buf_ctx, timeout, remote, NULL);
616 }
617 
652 ssize_t sock_ip_send_aux(sock_ip_t *sock, const void *data, size_t len,
653  uint8_t proto, const sock_ip_ep_t *remote,
654  sock_ip_aux_tx_t *aux);
655 
688 static inline ssize_t sock_ip_send(sock_ip_t *sock,
689  const void *data, size_t len,
690  uint8_t proto, const sock_ip_ep_t *remote)
691 {
692  return sock_ip_send_aux(sock, data, len, proto, remote, NULL);
693 }
694 
695 #include "sock_types.h"
696 
697 #ifdef __cplusplus
698 }
699 #endif
700 
701 #endif /* NET_SOCK_IP_H */
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.
ssize_t sock_ip_recv_buf_aux(sock_ip_t *sock, void **data, void **buf_ctx, uint32_t timeout, sock_ip_ep_t *remote, sock_ip_aux_rx_t *aux)
Provides stack-internal buffer space containing an IPv4/IPv6 message from remote end point.
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.
void sock_ip_close(sock_ip_t *sock)
Closes a raw IPv4/IPv6 sock object.
static 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.
Definition: ip.h:688
static 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.
Definition: ip.h:611
ssize_t sock_ip_recv_aux(sock_ip_t *sock, void *data, size_t max_len, uint32_t timeout, sock_ip_ep_t *remote, sock_ip_aux_rx_t *aux)
Receives a message over IPv4/IPv6 from remote end point.
ssize_t sock_ip_send_aux(sock_ip_t *sock, const void *data, size_t len, uint8_t proto, const sock_ip_ep_t *remote, sock_ip_aux_tx_t *aux)
Sends a message over IPv4/IPv6 to remote end point.
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.
static 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.
Definition: ip.h:515
uint8_t sock_aux_flags_t
Type holding the flags used to request specific auxiliary data.
Definition: sock.h:316
Common sock API definitions.
Auxiliary data provided when receiving using an IP sock object.
Definition: ip.h:303
int16_t rssi
RSSI value of the received frame.
Definition: ip.h:326
sock_ip_ep_t local
The local address the packet was received on.
Definition: ip.h:310
sock_aux_flags_t flags
Flags used request information.
Definition: ip.h:328
uint64_t timestamp
System time the packet was received.
Definition: ip.h:318
Auxiliary data provided when sending using an IP sock object.
Definition: ip.h:334
uint64_t timestamp
System time the packet was send.
Definition: ip.h:348
sock_aux_flags_t flags
Flags used request information.
Definition: ip.h:350
Abstract IP end point and end point for a raw IP sock object.
Definition: sock.h:175
Raw IP sock type.
Definition: sock_types.h:91