net_2sock_2async_2event_8h_source.html

/*

 * SPDX-FileCopyrightText: 2019 Freie Universität Berlin

 * SPDX-License-Identifier: LGPL-2.1-only

 */


#pragma once


#include "event.h"

/* guard required since `sock_dtls_types.h` might not be provided */

#ifdef MODULE_SOCK_DTLS

#include "net/sock/dtls.h"

#endif  /* MODULE_SOCK_DTLS */

#include "net/sock/ip.h"

#include "net/sock/tcp.h"

#include "net/sock/udp.h"

#include "net/sock/async.h"


#ifdef __cplusplus

extern "C" {

#endif


/* guard required since `sock_dtls_types.h` might not be provided */

#if defined(MODULE_SOCK_DTLS) || defined(DOXYGEN)

void sock_dtls_event_init(sock_dtls_t *sock, event_queue_t *ev_queue,

                          sock_dtls_cb_t handler, void *handler_arg);


void sock_dtls_event_close(sock_dtls_t *sock);

#endif  /* defined(MODULE_SOCK_DTLS) || defined(DOXYGEN) */


#if defined(MODULE_SOCK_IP) || defined(DOXYGEN)

void sock_ip_event_init(sock_ip_t *sock, event_queue_t *ev_queue,

                        sock_ip_cb_t handler, void *handler_arg);


void sock_ip_event_close(sock_ip_t *sock);

#endif  /* defined(MODULE_SOCK_IP) || defined(DOXYGEN) */


#if defined(MODULE_SOCK_TCP) || defined(DOXYGEN)

void sock_tcp_event_init(sock_tcp_t *sock, event_queue_t *ev_queue,

                         sock_tcp_cb_t handler, void *handler_arg);


void sock_tcp_event_close(sock_tcp_t *sock);


void sock_tcp_queue_event_init(sock_tcp_queue_t *queue, event_queue_t *ev_queue,

                               sock_tcp_queue_cb_t handler, void *handler_arg);

#endif  /* defined(MODULE_SOCK_TCP) || defined(DOXYGEN) */


#if defined(MODULE_SOCK_UDP) || defined(DOXYGEN)

void sock_udp_event_init(sock_udp_t *sock, event_queue_t *ev_queue,

                         sock_udp_cb_t handler, void *handler_arg);


void sock_udp_event_close(sock_udp_t *sock);


#endif  /* defined(MODULE_SOCK_UDP) || defined(DOXYGEN) */


void sock_event_close(sock_async_ctx_t *async_ctx);


#ifdef __cplusplus

}

#endif


async.h
Definitions for sock extension for asynchronous access.

sock_tcp_event_init
void sock_tcp_event_init(sock_tcp_t *sock, event_queue_t *ev_queue, sock_tcp_cb_t handler, void *handler_arg)
Makes a TCP sock able to handle asynchronous events using Event Queue.

sock_dtls_event_close
void sock_dtls_event_close(sock_dtls_t *sock)
Close a possibly async DTLS socket.

sock_event_close
void sock_event_close(sock_async_ctx_t *async_ctx)
clear any pending socket async events

sock_dtls_event_init
void sock_dtls_event_init(sock_dtls_t *sock, event_queue_t *ev_queue, sock_dtls_cb_t handler, void *handler_arg)
Makes a DTLS sock able to handle asynchronous events using Event Queue.

sock_ip_event_init
void sock_ip_event_init(sock_ip_t *sock, event_queue_t *ev_queue, sock_ip_cb_t handler, void *handler_arg)
Makes a raw IPv4/IPv6 sock able to handle asynchronous events using Event Queue.

sock_tcp_event_close
void sock_tcp_event_close(sock_tcp_t *sock)
Close a possibly async TCP socket.

sock_udp_event_close
void sock_udp_event_close(sock_udp_t *sock)
Close a possibly async UDP socket.

sock_tcp_queue_event_init
void sock_tcp_queue_event_init(sock_tcp_queue_t *queue, event_queue_t *ev_queue, sock_tcp_queue_cb_t handler, void *handler_arg)
Makes a TCP listening queue able to handle asynchronous events using Event Queue.

sock_ip_event_close
void sock_ip_event_close(sock_ip_t *sock)
Close a possibly async IP socket.

sock_udp_event_init
void sock_udp_event_init(sock_udp_t *sock, event_queue_t *ev_queue, sock_udp_cb_t handler, void *handler_arg)
Makes a UDP sock able to handle asynchronous events using Event Queue.

sock_tcp_t
struct sock_tcp sock_tcp_t
forward declare for async
Definition types.h:93

sock_tcp_queue_cb_t
void(* sock_tcp_queue_cb_t)(sock_tcp_queue_t *queue, sock_async_flags_t flags, void *arg)
Event callback for sock_tcp_queue_t.
Definition types.h:130

sock_tcp_queue_t
struct sock_tcp_queue sock_tcp_queue_t
forward declare for async
Definition types.h:94

sock_udp_cb_t
void(* sock_udp_cb_t)(sock_udp_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_udp_t.
Definition types.h:154

sock_udp_t
struct sock_udp sock_udp_t
forward declare for async
Definition types.h:136

sock_ip_t
struct sock_ip sock_ip_t
forward declare for async
Definition types.h:70

sock_tcp_cb_t
void(* sock_tcp_cb_t)(sock_tcp_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_tcp_t.
Definition types.h:114

sock_ip_cb_t
void(* sock_ip_cb_t)(sock_ip_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_ip_t.
Definition types.h:88

sock_dtls_t
struct sock_dtls sock_dtls_t
forward declare for async
Definition types.h:44

sock_dtls_cb_t
void(* sock_dtls_cb_t)(sock_dtls_t *sock, sock_async_flags_t flags, void *arg)
Event callback for sock_dtls_t.
Definition types.h:65

event_queue_t
struct PTRTAG event_queue_t
event queue structure

ip.h
Raw IPv4/IPv6 sock definitions.

event.h
Asynchronous sock using Event Queue definitions.

dtls.h
DTLS sock definitions.

tcp.h
TCP sock definitions.

udp.h
UDP sock definitions.

sock_async_ctx_t
Asynchronous context for Asynchronous sock with event API.
Definition sock_async_ctx.h:64