mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-02 07:55:46 +03:00
Jon Shallow
8b2fb390b8
Support of RFC9146. Currently only Mbed TLS supported. New function coap_context_set_cid_tuple_change() for a client to force periodic source port changes to test out CID. Configurable support for the client to use Connection-ID assuming underlying DTLS library is configured for or supports it.
238 lines
7.8 KiB
C
238 lines
7.8 KiB
C
/*
|
|
* coap_io.h -- Default network I/O functions for libcoap
|
|
*
|
|
* Copyright (C) 2012-2024 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 "coap_layers_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"
|
|
#include "net/sock/udp.h"
|
|
#if ! COAP_DISABLE_TCP
|
|
#include "net/sock/tcp.h"
|
|
#endif /* ! COAP_DISABLE_TCP */
|
|
#endif /* RIOT_VERSION */
|
|
|
|
struct coap_socket_t {
|
|
#if defined(WITH_LWIP)
|
|
struct pbuf *p;
|
|
struct udp_pcb *udp_pcb;
|
|
#if ! COAP_DISABLE_TCP
|
|
struct tcp_pcb *tcp_pcb;
|
|
#endif /* ! COAP_DISABLE_TCP */
|
|
|
|
#elif defined(WITH_CONTIKI)
|
|
struct uip_udp_conn *udp_conn;
|
|
coap_context_t *context;
|
|
|
|
#elif defined(RIOT_VERSION)
|
|
sock_udp_t udp;
|
|
#if ! COAP_DISABLE_TCP
|
|
sock_tcp_t tcp;
|
|
#endif /* ! COAP_DISABLE_TCP */
|
|
coap_fd_t fd;
|
|
#else
|
|
coap_fd_t fd;
|
|
#endif /* ! WITH_LWIP && !WITH_CONTIKI && ! RIOT_VERSION */
|
|
coap_socket_flags_t flags; /**< 1 or more of COAP_SOCKET* flag values */
|
|
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 */
|
|
#if COAP_CLIENT_SUPPORT
|
|
coap_address_t mcast_addr; /**< remote address and port (multicast track) */
|
|
#endif /* COAP_CLIENT_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 */
|
|
|
|
#if COAP_SERVER_SUPPORT
|
|
int coap_socket_bind_udp(coap_socket_t *sock,
|
|
const coap_address_t *listen_addr,
|
|
coap_address_t *bound_addr);
|
|
#endif /* COAP_SERVER_SUPPORT */
|
|
|
|
/**
|
|
* 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 when to continue with I/O processing, unless packets come in in the
|
|
* meantime. Typically, this timeout triggers retransmissions.
|
|
*
|
|
* @param context The CoAP context.
|
|
* @param delay The time to delay before continuing with I/O processing.
|
|
*/
|
|
void coap_update_io_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, 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);
|
|
void coap_io_lwip_init(void);
|
|
void coap_io_lwip_cleanup(void);
|
|
#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_ */
|