udp.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_UDP_H
269 #define NET_SOCK_UDP_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 
288 typedef struct _sock_tl_ep sock_udp_ep_t;
296 typedef struct sock_udp sock_udp_t;
297 
298 #if defined (__clang__)
299 # pragma clang diagnostic pop
300 #endif
301 
345  const sock_udp_ep_t *remote, uint16_t flags);
346 
354 void sock_udp_close(sock_udp_t *sock);
355 
368 
380 
412 ssize_t sock_udp_recv(sock_udp_t *sock, void *data, size_t max_len,
413  uint32_t timeout, sock_udp_ep_t *remote);
414 
457 ssize_t sock_udp_recv_buf(sock_udp_t *sock, void **data, void **buf_ctx,
458  uint32_t timeout, sock_udp_ep_t *remote);
459 
493 ssize_t sock_udp_send(sock_udp_t *sock, const void *data, size_t len,
494  const sock_udp_ep_t *remote);
495 
496 #include "sock_types.h"
497 
498 #ifdef __cplusplus
499 }
500 #endif
501 
502 #endif /* NET_SOCK_UDP_H */
503 
sock_udp::flags
uint16_t flags
option flags
Definition: sock_types.h:136
sock_udp_recv
ssize_t sock_udp_recv(sock_udp_t *sock, void *data, size_t max_len, uint32_t timeout, sock_udp_ep_t *remote)
Receives a UDP message from a remote end point.
sock_udp_send
ssize_t sock_udp_send(sock_udp_t *sock, const void *data, size_t len, const sock_udp_ep_t *remote)
Sends a UDP message to remote end point.
sock_udp_get_local
int sock_udp_get_local(sock_udp_t *sock, sock_udp_ep_t *ep)
Gets the local end point of a UDP sock object.
sock_udp_get_remote
int sock_udp_get_remote(sock_udp_t *sock, sock_udp_ep_t *ep)
Gets the remote end point of a UDP sock object.
sock_udp
UDP sock type.
Definition: sock_types.h:128
_sock_tl_ep
Common IP-based transport layer end point.
Definition: sock.h:213
sock_udp_recv_buf
ssize_t sock_udp_recv_buf(sock_udp_t *sock, void **data, void **buf_ctx, uint32_t timeout, sock_udp_ep_t *remote)
Provides stack-internal buffer space containing a UDP message from a remote end point.
sock_udp::remote
sock_udp_ep_t remote
remote end-point
Definition: sock_types.h:135
sock_udp::local
sock_udp_ep_t local
local end-point
Definition: sock_types.h:134
sock.h
Common sock API definitions.
sock_udp_create
int sock_udp_create(sock_udp_t *sock, const sock_udp_ep_t *local, const sock_udp_ep_t *remote, uint16_t flags)
Creates a new UDP sock object.
sock_udp_close
void sock_udp_close(sock_udp_t *sock)
Closes a UDP sock object.