Files
libcoap/include/coap3/coap_io_internal.h
T
Jon Shallow adb8a3f5e2 layers: Add in protocol layers support
Current stack:-

Application
CoAP
CoAP-Session
DTLS
Netif
Sockets
Network Stack

Depending on the CoAP protocol, indexing functions through coap_layers_coap[]
(in src/coap_io.c) will invoke the correct layer function when used at the
CoAP and DTLS layers.

It is then easy to add in another protocol layer by updating coap_layers_coap[].
2023-03-20 10:49:02 +00:00

311 lines
10 KiB
C

/*
* coap_io.h -- Default network I/O functions for libcoap
*
* Copyright (C) 2012-2023 Olaf Bergmann <bergmann@tzi.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*
* This file is part of the CoAP library libcoap. Please see README for terms
* of use.
*/
/**
* @file coap_io_internal.h
* @brief Internal network I/O functions
*/
#ifndef COAP_IO_INTERNAL_H_
#define COAP_IO_INTERNAL_H_
#include "coap_internal.h"
#include <sys/types.h>
#include "coap_address.h"
#ifdef WITH_CONTIKI
struct uip_udp_conn;
#endif /* WITH_CONTIKI */
#ifdef RIOT_VERSION
#include "net/gnrc.h"
#endif /* RIOT_VERSION */
typedef enum {
COAP_LAYER_SESSION,
COAP_LAYER_TLS,
COAP_LAYER_LAST
} coap_layer_t;
/**
* Function read interface for layer data receiving.
*
* If a called lower layer returned value is 0 or less, this must get passed
* back to the caller.
*
* If the layer function consumes all the data (i.e. to handle the protocol
* layer requirements), then the function must return 0 to indicate no data.
*
* Otherwise data must get updated (limited by datalen) and the number of bytes
* available returned.
*
* Note: If the number of returned bytes is less that read in, then
* COAP_SOCKET_CAN_READ must be dropped from session->sock.flags.
*
* @param session Session to receive data on.
* @param data The data to receive.
* @param datalen The maximum length of @p data.
*
* @return >=0 Number of bytes read.
* -1 Error error in errno).
* -2 Recieved ICMP unreachable.
*/
typedef ssize_t (*coap_layer_read_t)(coap_session_t *session,
uint8_t *data, size_t datalen);
/**
* Function write interface for layer data sending.
*
* If a called lower layer returned value is 0 or less, this must get passed
* back to the caller.
*
* If the layer function cannot transmit any data (congestion control etc.),
* then the function must return 0 to indicate no data sent.
*
* It is possible that not all the data is sent (congestion control etc.),
* and bytes written is less that datalen.
*
* Note: If the number of returned bytes is less that to be written,
* COAP_SOCKET_WANT_WRITE must be added to session->sock.flags.
*
* @param session Session to receive data on.
* @param data The data to write out.
* @param datalen The maximum length of @p data.
*
* @return >=0 Number of bytes written.
* -1 Error error in errno).
*/
typedef ssize_t (*coap_layer_write_t)(coap_session_t *session,
const uint8_t *data, size_t datalen);
/**
* Function establish interface for layer establish handling.
*
* If this layer is properly established on invocation, then the next layer
* must get called by calling
* session->lfunc[_this_layer_].establish(session)
* (or done at any point when layer is established).
* If the establishment of a layer fails, then
* coap_session_disconnected(session, COAP_NACK_xxx_LAYER_FAILED) must be
* called.
*
* @param session Session being established
*/
typedef void (*coap_layer_establish_t)(coap_session_t *session);
/**
* Function close interface for layer closing.
*
* When this layer is properly closed, then the next layer
* must get called by calling
* session->lfunc[_this_layer_].close(session)
* (or done at any point when layer is closed).
*
* @param session Session being closed.
*/
typedef void (*coap_layer_close_t)(coap_session_t *session);
typedef struct {
coap_layer_read_t read; /* Get data from next layer (TCP) */
coap_layer_write_t write; /* Output data to next layer */
coap_layer_establish_t establish; /* Layer establish */
coap_layer_close_t close; /* Connection close */
} coap_layer_func_t;
extern coap_layer_func_t coap_layers_coap[COAP_PROTO_LAST][COAP_LAYER_LAST];
struct coap_socket_t {
#if defined(WITH_LWIP)
struct udp_pcb *pcb;
#elif defined(WITH_CONTIKI)
struct uip_udp_conn *udp_conn;
coap_context_t *context;
#else
coap_fd_t fd;
#endif /* WITH_LWIP */
#if defined(RIOT_VERSION)
gnrc_pktsnip_t *pkt; /* pointer to received packet for processing */
#endif /* RIOT_VERSION */
coap_socket_flags_t flags;
coap_session_t *session; /* Used to determine session owner. */
#if COAP_SERVER_SUPPORT
coap_endpoint_t *endpoint; /* Used by the epoll logic for a listening
endpoint. */
#endif /* COAP_SERVER_SUPPORT */
coap_layer_func_t lfunc[COAP_LAYER_LAST]; /* Layer functions to use */
};
/**
* coap_socket_flags_t values
*/
#define COAP_SOCKET_EMPTY 0x0000 /**< the socket is not used */
#define COAP_SOCKET_NOT_EMPTY 0x0001 /**< the socket is not empty */
#define COAP_SOCKET_BOUND 0x0002 /**< the socket is bound */
#define COAP_SOCKET_CONNECTED 0x0004 /**< the socket is connected */
#define COAP_SOCKET_WANT_READ 0x0010 /**< non blocking socket is waiting for reading */
#define COAP_SOCKET_WANT_WRITE 0x0020 /**< non blocking socket is waiting for writing */
#define COAP_SOCKET_WANT_ACCEPT 0x0040 /**< non blocking server socket is waiting for accept */
#define COAP_SOCKET_WANT_CONNECT 0x0080 /**< non blocking client socket is waiting for connect */
#define COAP_SOCKET_CAN_READ 0x0100 /**< non blocking socket can now read without blocking */
#define COAP_SOCKET_CAN_WRITE 0x0200 /**< non blocking socket can now write without blocking */
#define COAP_SOCKET_CAN_ACCEPT 0x0400 /**< non blocking server socket can now accept without blocking */
#define COAP_SOCKET_CAN_CONNECT 0x0800 /**< non blocking client socket can now connect without blocking */
#define COAP_SOCKET_MULTICAST 0x1000 /**< socket is used for multicast communication */
#if COAP_SERVER_SUPPORT
coap_endpoint_t *coap_malloc_endpoint( void );
void coap_mfree_endpoint( coap_endpoint_t *ep );
#endif /* COAP_SERVER_SUPPORT */
const char *coap_socket_format_errno(int error);
#if COAP_CLIENT_SUPPORT
int
coap_socket_connect_udp(coap_socket_t *sock,
const coap_address_t *local_if,
const coap_address_t *server,
int default_port,
coap_address_t *local_addr,
coap_address_t *remote_addr);
#endif /* COAP_CLIENT_SUPPORT */
int
coap_socket_bind_udp(coap_socket_t *sock,
const coap_address_t *listen_addr,
coap_address_t *bound_addr );
/**
* Function interface to close off a socket.
*
* @param sock Socket to close.
*
*/
void coap_socket_close(coap_socket_t *sock);
/**
* Function interface for data stream sending off a socket.
*
* @param sock Socket to send data over.
* @param data The data to send.
* @param data_len The length of @p data.
*
* @return >=0 Number of bytes sent.
* -1 Error error in errno).
*/
ssize_t coap_socket_write(coap_socket_t *sock, const uint8_t *data, size_t data_len);
/**
* Function interface for data stream receiving off a socket.
*
* @param sock Socket to receive data on.
* @param data The data to receive.
* @param data_len The maximum length of @p data.
*
* @return >=0 Number of bytes read.
* -1 Error error in errno).
*/
ssize_t coap_socket_read(coap_socket_t *sock, uint8_t *data, size_t data_len);
/**
* Epoll specific function to add the state of events that epoll is to track
* for the appropriate file descriptor.
*
* @param sock Socket information.
* @param events The Epoll events to update
* @param func Function that this function was called from.
*
*/
void coap_epoll_ctl_add(coap_socket_t *sock, uint32_t events, const char *func);
/**
* Epoll specific function to modify the state of events that epoll is tracking
* on the appropriate file descriptor.
*
* @param sock Socket information.
* @param events The Epoll events to update
* @param func Function that this function was called from.
*
*/
void coap_epoll_ctl_mod(coap_socket_t *sock, uint32_t events, const char *func);
/**
* Update the epoll timer fd as to when it is to trigger.
*
* @param context The context to update the epoll timer on.
* @param delay The time to delay before the epoll timer fires.
*/
void coap_update_epoll_timer(coap_context_t *context, coap_tick_t delay);
#ifdef WITH_LWIP
ssize_t
coap_socket_send_pdu( coap_socket_t *sock, coap_session_t *session,
coap_pdu_t *pdu );
#endif
/**
* Function interface for data transmission. This function returns the number of
* bytes that have been transmitted, or a value less than zero on error.
*
* @param sock Socket to send data over.
* @param session Addressing information for unconnected sockets, or NULL
* @param data The data to send.
* @param datalen The actual length of @p data.
*
* @return The number of bytes written on success, or a value
* less than zero on error.
*/
ssize_t coap_socket_send(coap_socket_t *sock, const coap_session_t *session,
const uint8_t *data, size_t datalen);
/**
* Function interface for reading data. This function returns the number of
* bytes that have been read, or a value less than zero on error. In case of an
* error, @p *packet is set to NULL.
*
* @param sock Socket to read data from.
* @param packet Received packet metadata and payload. src and dst
* should be preset.
*
* @return The number of bytes received on success, or a value less than
* zero on error.
*/
ssize_t coap_socket_recv(coap_socket_t *sock, coap_packet_t *packet);
#ifndef coap_mcast_interface
# define coap_mcast_interface(Local) 0
#endif
/**
* Given a packet, set msg and msg_len to an address and length of the packet's
* data in memory.
* */
void coap_packet_get_memmapped(coap_packet_t *packet,
unsigned char **address,
size_t *length);
#ifdef WITH_LWIP
void coap_io_process_timeout(void *arg);
#endif
struct coap_packet_t {
coap_addr_tuple_t addr_info; /**< local and remote addresses */
int ifindex; /**< the interface index */
size_t length; /**< length of payload */
unsigned char *payload; /**< payload */
};
#ifdef WITH_CONTIKI
void coap_start_io_process(void);
void coap_stop_io_process(void);
#endif /* WITH_CONTIKI */
#endif /* COAP_IO_INTERNAL_H_ */