coap_io_internal.h

Go to the documentation of this file.

/*
 * coap_io.h -- Default network I/O functions for libcoap
 *
 * Copyright (C) 2012-2025 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.
 */
 
#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; 
  coap_session_t *session; 
#if COAP_SERVER_SUPPORT
  coap_endpoint_t *endpoint; 
#endif /* COAP_SERVER_SUPPORT */
#if COAP_CLIENT_SUPPORT
  coap_address_t mcast_addr; 
#endif /* COAP_CLIENT_SUPPORT */
  coap_layer_func_t lfunc[COAP_LAYER_LAST]; 
};
 
#define COAP_SOCKET_EMPTY        0x0000  
#define COAP_SOCKET_NOT_EMPTY    0x0001  
#define COAP_SOCKET_BOUND        0x0002  
#define COAP_SOCKET_CONNECTED    0x0004  
#define COAP_SOCKET_WANT_READ    0x0010  
#define COAP_SOCKET_WANT_WRITE   0x0020  
#define COAP_SOCKET_WANT_ACCEPT  0x0040  
#define COAP_SOCKET_WANT_CONNECT 0x0080  
#define COAP_SOCKET_CAN_READ     0x0100  
#define COAP_SOCKET_CAN_WRITE    0x0200  
#define COAP_SOCKET_CAN_ACCEPT   0x0400  
#define COAP_SOCKET_CAN_CONNECT  0x0800  
#define COAP_SOCKET_MULTICAST    0x1000  
#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 */
 
void coap_socket_close(coap_socket_t *sock);
 
ssize_t coap_socket_write(coap_socket_t *sock, const uint8_t *data, size_t data_len);
 
ssize_t coap_socket_read(coap_socket_t *sock, uint8_t *data, size_t data_len);
 
void coap_epoll_ctl_add(coap_socket_t *sock, uint32_t events, const char *func);
 
void coap_epoll_ctl_mod(coap_socket_t *sock, uint32_t events, const char *func);
 
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
 
ssize_t coap_socket_send(coap_socket_t *sock, coap_session_t *session,
                         const uint8_t *data, size_t datalen);
 
ssize_t coap_socket_recv(coap_socket_t *sock, coap_packet_t *packet);
 
#ifndef coap_mcast_interface
# define coap_mcast_interface(Local) 0
#endif
 
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; 
  int ifindex;                
  size_t length;             
  unsigned char *payload;    
};
 
#ifdef WITH_CONTIKI
void coap_start_io_process(void);
void coap_stop_io_process(void);
#endif /* WITH_CONTIKI */
 
#endif /* COAP_IO_INTERNAL_H_ */