Loading...
Searching...
No Matches
coap_net.h
Go to the documentation of this file.
/*
* coap_net.h -- CoAP context interface
*
* Copyright (C) 2010-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.
*/
#ifndef COAP_NET_H_
#define COAP_NET_H_
#include <stdlib.h>
#include <string.h>
#ifndef _WIN32
#ifdef HAVE_SYS_SELECT_H
#include <sys/select.h>
#endif /* HAVE_SYS_SELECT_H */
#include <sys/time.h>
#endif
#include <time.h>
#ifdef WITH_LWIP
#include <lwip/ip_addr.h>
#endif
#include "coap_io.h"
#include "coap_dtls.h"
#include "coap_event.h"
#include "coap_pdu.h"
#include "coap_session.h"
#include "coap_debug.h"
typedef enum coap_response_t {
COAP_RESPONSE_FAIL,
COAP_RESPONSE_OK
} coap_response_t;
typedef coap_response_t (*coap_response_handler_t)(coap_session_t *session,
const coap_pdu_t *sent,
const coap_pdu_t *received,
const coap_mid_t mid);
typedef void (*coap_nack_handler_t)(coap_session_t *session,
const coap_pdu_t *sent,
const coap_nack_reason_t reason,
const coap_mid_t mid);
typedef void (*coap_ping_handler_t)(coap_session_t *session,
const coap_pdu_t *received,
const coap_mid_t mid);
typedef void (*coap_pong_handler_t)(coap_session_t *session,
const coap_pdu_t *received,
const coap_mid_t mid);
void coap_register_response_handler(coap_context_t *context,
coap_response_handler_t handler);
void coap_register_nack_handler(coap_context_t *context,
coap_nack_handler_t handler);
void coap_register_ping_handler(coap_context_t *context,
coap_ping_handler_t handler);
void coap_register_pong_handler(coap_context_t *context,
coap_pong_handler_t handler);
COAP_API void coap_register_option(coap_context_t *ctx, uint16_t type);
coap_context_t *coap_new_context(const coap_address_t *listen_addr);
COAP_API int coap_context_set_psk(coap_context_t *context, const char *hint,
const uint8_t *key, size_t key_len);
COAP_API int coap_context_set_psk2(coap_context_t *context,
coap_dtls_spsk_t *setup_data);
COAP_API int coap_context_set_pki(coap_context_t *context,
const coap_dtls_pki_t *setup_data);
COAP_API int coap_context_set_pki_root_cas(coap_context_t *context,
const char *ca_file,
const char *ca_dir);
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
int coap_context_set_cid_tuple_change(coap_context_t *context, uint8_t every);
void coap_context_set_max_token_size(coap_context_t *context,
size_t max_token_size);
int coap_context_get_coap_fd(const coap_context_t *context);
void coap_context_set_max_idle_sessions(coap_context_t *context,
unsigned int max_idle_sessions);
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context);
void coap_context_set_session_timeout(coap_context_t *context,
unsigned int session_timeout);
unsigned int coap_context_get_session_timeout(const coap_context_t *context);
COAP_DEPRECATED void coap_context_set_csm_timeout(coap_context_t *context,
unsigned int csm_timeout);
COAP_DEPRECATED unsigned int coap_context_get_csm_timeout(const coap_context_t *context);
void coap_context_set_csm_timeout_ms(coap_context_t *context,
unsigned int csm_timeout_ms);
unsigned int coap_context_get_csm_timeout_ms(const coap_context_t *context);
void coap_context_set_csm_max_message_size(coap_context_t *context,
uint32_t csm_max_message_size);
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context);
void coap_context_set_max_handshake_sessions(coap_context_t *context,
unsigned int max_handshake_sessions);
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context);
COAP_API uint16_t coap_new_message_id(coap_session_t *session);
COAP_API void coap_free_context(coap_context_t *context);
void coap_set_app_data(coap_context_t *context, void *data);
void *coap_get_app_data(const coap_context_t *context);
coap_pdu_t *coap_new_error_response(const coap_pdu_t *request,
coap_pdu_code_t code,
coap_opt_filter_t *opts);
COAP_API coap_mid_t coap_send_error(coap_session_t *session,
const coap_pdu_t *request,
coap_pdu_code_t code,
coap_opt_filter_t *opts);
COAP_API coap_mid_t coap_send_message_type(coap_session_t *session, const coap_pdu_t *request,
coap_pdu_type_t type);
COAP_API coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request);
COAP_API coap_mid_t coap_send_rst(coap_session_t *session, const coap_pdu_t *request);
COAP_API coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu);
#define coap_send_large(session, pdu) coap_send(session, pdu)
COAP_API int coap_handle_event(coap_context_t *context,
coap_event_t event,
coap_session_t *session);
COAP_API int coap_can_exit(coap_context_t *context);
void coap_ticks(coap_tick_t *);
COAP_API int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
const char *ifname);
#define coap_join_mcast_group(ctx, groupname) \
(coap_join_mcast_group_intf(ctx, groupname, NULL))
int coap_mcast_set_hops(coap_session_t *session, size_t hops);
void coap_mcast_per_resource(coap_context_t *context);
void coap_context_set_app_data(coap_context_t *context, void *data);
void *coap_context_get_app_data(const coap_context_t *context);
#define COAP_IO_WAIT 0
#define COAP_IO_NO_WAIT ((uint32_t)-1)
COAP_API int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
#if !defined(RIOT_VERSION) && !defined(WITH_CONTIKI)
COAP_API int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms,
int nfds, fd_set *readfds, fd_set *writefds,
fd_set *exceptfds);
#endif /* ! RIOT_VERSION && ! WITH_CONTIKI */
COAP_API int coap_io_pending(coap_context_t *context);
COAP_API unsigned int coap_io_prepare_io(coap_context_t *ctx,
coap_socket_t *sockets[],
unsigned int max_sockets,
unsigned int *num_sockets,
coap_tick_t now
);
COAP_API void coap_io_do_io(coap_context_t *ctx, coap_tick_t now);
COAP_API unsigned int coap_io_prepare_epoll(coap_context_t *ctx, coap_tick_t now);
struct epoll_event;
COAP_API void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events,
size_t nevents);
#if defined(WITH_LWIP) || defined(WITH_LWIP_MAN_CHECK) || defined(__DOXYGEN__)
void coap_lwip_dump_memory_pools(coap_log_t log_level);
typedef int (*coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs);
void coap_lwip_set_input_wait_handler(coap_context_t *context,
coap_lwip_input_wait_handler_t handler,
void *input_arg);
#endif /* WITH_LWIP || WITH_LWIP_MAN_CHECK || defined(__DOXYGEN__) */
#define coap_run_once(ctx, timeout_ms) coap_io_process(ctx, timeout_ms)
#define coap_write(ctx, sockets, max_sockets, num_sockets, now) \
coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now)
#define coap_read(ctx, now) coap_io_do_io(ctx, now)
/* Old definitions which may be hanging around in old code - be helpful! */
#define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
#define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
#endif /* COAP_NET_H_ */
coap_debug.h
CoAP Logging support.
coap_dtls.h
CoAP DTLS support.
coap_event.h
Event handling.
coap_io.h
Default network I/O functions.
coap_nack_reason_t
coap_nack_reason_t
Definition coap_io.h:62
COAP_API
#define COAP_API
Definition coap_libcoap_build.h:41
coap_pdu.h
Pre-defined constants that reflect defaults for CoAP.
coap_session.h
Defines the application visible session information.
coap_io_process
COAP_API int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition coap_io.c:1581
coap_io_pending
COAP_API int coap_io_pending(coap_context_t *context)
Check to see if there is any i/o pending for the context.
Definition coap_io.c:1825
coap_io_prepare_io
COAP_API unsigned int coap_io_prepare_io(coap_context_t *ctx, coap_socket_t *sockets[], unsigned int max_sockets, unsigned int *num_sockets, coap_tick_t now)
Iterates through all the coap_socket_t structures embedded in endpoints or sessions associated with t...
Definition coap_io.c:1303
coap_io_prepare_epoll
COAP_API unsigned int coap_io_prepare_epoll(coap_context_t *ctx, coap_tick_t now)
Any now timed out delayed packet is transmitted, along with any packets associated with requested obs...
Definition coap_io.c:1242
coap_io_process_with_fds
COAP_API int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms, int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds)
The main message processing loop with additional fds for internal select.
Definition coap_io.c:1596
coap_io_do_epoll
COAP_API void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition coap_net.c:2367
coap_io_do_io
COAP_API void coap_io_do_io(coap_context_t *ctx, coap_tick_t now)
Processes any outstanding read, write, accept or connect I/O as indicated in the coap_socket_t struct...
Definition coap_net.c:2306
coap_tick_t
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
coap_context_set_session_timeout
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition coap_net.c:546
coap_context_get_max_handshake_sessions
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:499
coap_join_mcast_group_intf
COAP_API int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname, const char *ifname)
Function interface for joining a multicast group for listening for the currently defined endpoints th...
coap_pong_handler_t
void(* coap_pong_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Pong handler that is used as callback in coap_context_t.
Definition coap_net.h:100
coap_context_get_max_idle_sessions
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition coap_net.c:488
coap_new_context
coap_context_t * coap_new_context(const coap_address_t *listen_addr)
Creates a new coap_context_t object that will hold the CoAP stack status.
Definition coap_net.c:642
coap_send
COAP_API coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1346
coap_context_set_pki
COAP_API int coap_context_set_pki(coap_context_t *context, const coap_dtls_pki_t *setup_data)
Set the context's default PKI information for a server.
coap_mcast_per_resource
void coap_mcast_per_resource(coap_context_t *context)
Function interface to enable processing mcast requests on a per resource basis.
coap_response_handler_t
coap_response_t(* coap_response_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_pdu_t *received, const coap_mid_t mid)
Response handler that is used as callback in coap_context_t.
Definition coap_net.h:64
coap_send_error
COAP_API coap_mid_t coap_send_error(coap_session_t *session, const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Sends an error response with code code for request request to dst.
Definition coap_net.c:1053
coap_context_set_csm_max_message_size
void coap_context_set_csm_max_message_size(coap_context_t *context, uint32_t csm_max_message_size)
Set the CSM max session size value.
Definition coap_net.c:534
coap_context_set_csm_timeout
COAP_DEPRECATED void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_timeout)
Set the CSM timeout value.
Definition coap_net.c:506
coap_register_response_handler
void coap_register_response_handler(coap_context_t *context, coap_response_handler_t handler)
Registers a new message handler that is called whenever a response is received.
Definition coap_net.c:4512
coap_new_error_response
coap_pdu_t * coap_new_error_response(const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Creates a new ACK PDU with specified error code.
Definition coap_net.c:2649
coap_context_set_max_handshake_sessions
void coap_context_set_max_handshake_sessions(coap_context_t *context, unsigned int max_handshake_sessions)
Set the maximum number of sessions in (D)TLS handshake value.
Definition coap_net.c:493
coap_context_get_coap_fd
int coap_context_get_coap_fd(const coap_context_t *context)
Get the libcoap internal file descriptor for using in an application's select() or returned as an eve...
Definition coap_net.c:557
coap_mcast_set_hops
int coap_mcast_set_hops(coap_session_t *session, size_t hops)
Function interface for defining the hop count (ttl) for sending multicast traffic.
coap_context_set_app_data
void coap_context_set_app_data(coap_context_t *context, void *data)
Stores data with the given context.
Definition coap_net.c:630
coap_response_t
coap_response_t
Definition coap_net.h:48
coap_ping_handler_t
void(* coap_ping_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Ping handler that is used as callback in coap_context_t.
Definition coap_net.h:89
coap_ticks
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
coap_free_context
COAP_API void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition coap_net.c:746
coap_nack_handler_t
void(* coap_nack_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_nack_reason_t reason, const coap_mid_t mid)
Negative Acknowedge handler that is used as callback in coap_context_t.
Definition coap_net.h:77
coap_context_get_app_data
void * coap_context_get_app_data(const coap_context_t *context)
Returns any application-specific data that has been stored with context using the function coap_conte...
Definition coap_net.c:636
coap_context_set_pki_root_cas
COAP_API int coap_context_set_pki_root_cas(coap_context_t *context, const char *ca_file, const char *ca_dir)
Set the context's default Root CA information for a client or server.
Definition coap_net.c:436
coap_context_get_csm_max_message_size
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context)
Get the CSM max session size value.
Definition coap_net.c:541
coap_context_get_session_timeout
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:552
coap_context_set_psk
COAP_API int coap_context_set_psk(coap_context_t *context, const char *hint, const uint8_t *key, size_t key_len)
Set the context's default PSK hint and/or key for a server.
coap_register_option
COAP_API void coap_register_option(coap_context_t *ctx, uint16_t type)
Registers the option type type with the given context object ctx.
Definition coap_net.c:4541
coap_send_ack
COAP_API coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
Definition coap_net.c:976
coap_context_get_csm_timeout_ms
unsigned int coap_context_get_csm_timeout_ms(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:529
coap_new_message_id
COAP_API uint16_t coap_new_message_id(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
Definition coap_session.c:1899
coap_register_ping_handler
void coap_register_ping_handler(coap_context_t *context, coap_ping_handler_t handler)
Registers a new message handler that is called whenever a CoAP Ping message is received.
Definition coap_net.c:4529
coap_context_set_psk2
COAP_API int coap_context_set_psk2(coap_context_t *context, coap_dtls_spsk_t *setup_data)
Set the context's default PSK hint and/or key for a server.
coap_context_set_cid_tuple_change
int coap_context_set_cid_tuple_change(coap_context_t *context, uint8_t every)
Set the Connection ID client tuple frequency change for testing CIDs.
Definition coap_net.c:463
coap_get_app_data
void * coap_get_app_data(const coap_context_t *context)
Definition coap_net.c:740
coap_context_set_max_idle_sessions
void coap_context_set_max_idle_sessions(coap_context_t *context, unsigned int max_idle_sessions)
Set the maximum idle sessions count.
Definition coap_net.c:482
coap_send_message_type
COAP_API coap_mid_t coap_send_message_type(coap_session_t *session, const coap_pdu_t *request, coap_pdu_type_t type)
Helper function to create and send a message with type (usually ACK or RST).
Definition coap_net.c:1084
coap_send_rst
COAP_API coap_mid_t coap_send_rst(coap_session_t *session, const coap_pdu_t *request)
Sends an RST message with code 0 for the specified request to dst.
Definition coap_net.c:961
coap_context_set_keepalive
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition coap_net.c:458
coap_set_app_data
void coap_set_app_data(coap_context_t *context, void *data)
Definition coap_net.c:734
coap_can_exit
COAP_API int coap_can_exit(coap_context_t *context)
Returns 1 if there are no messages to send or to dispatch in the context's queues.
Definition coap_net.c:4376
coap_context_get_csm_timeout
COAP_DEPRECATED unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:513
coap_register_pong_handler
void coap_register_pong_handler(coap_context_t *context, coap_pong_handler_t handler)
Registers a new message handler that is called whenever a CoAP Pong message is received.
Definition coap_net.c:4535
coap_context_set_max_token_size
void coap_context_set_max_token_size(coap_context_t *context, size_t max_token_size)
Set the maximum token size (RFC8974).
Definition coap_net.c:474
coap_handle_event
COAP_API int coap_handle_event(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition coap_net.c:4347
coap_register_nack_handler
void coap_register_nack_handler(coap_context_t *context, coap_nack_handler_t handler)
Registers a new message handler that is called whenever a confirmable message (request or response) i...
Definition coap_net.c:4523
coap_context_set_csm_timeout_ms
void coap_context_set_csm_timeout_ms(coap_context_t *context, unsigned int csm_timeout_ms)
Set the CSM timeout value.
Definition coap_net.c:519
COAP_RESPONSE_FAIL
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition coap_net.h:49
COAP_RESPONSE_OK
@ COAP_RESPONSE_OK
Response is fine.
Definition coap_net.h:50
coap_event_t
coap_event_t
Scalar type to represent different events, e.g.
Definition coap_event.h:34
coap_log_t
coap_log_t
Logging type.
Definition coap_debug.h:50
coap_lwip_set_input_wait_handler
void coap_lwip_set_input_wait_handler(coap_context_t *context, coap_lwip_input_wait_handler_t handler, void *input_arg)
Set up a wait / timeout callback handler for use when the application calls coap_io_process().
coap_lwip_input_wait_handler_t
int(* coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs)
LwIP callback handler that can be used to wait / timeout for the next input packet.
Definition coap_net.h:836
coap_lwip_dump_memory_pools
void coap_lwip_dump_memory_pools(coap_log_t log_level)
Dump the current state of the LwIP memory pools.
coap_mid_t
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:263
coap_pdu_code_t
coap_pdu_code_t
Set of codes available for a PDU.
Definition coap_pdu.h:326
coap_pdu_type_t
coap_pdu_type_t
CoAP PDU message type definitions.
Definition coap_pdu.h:68
COAP_DEPRECATED
#define COAP_DEPRECATED
Definition libcoap.h:62
coap_address_t
Multi-purpose address abstraction.
Definition coap_address.h:148
coap_context_t
The CoAP stack's global state is stored in a coap_context_t object.
Definition coap_net_internal.h:50
coap_dtls_pki_t
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:312
coap_dtls_spsk_t
The structure used for defining the Server PSK setup data to be used.
Definition coap_dtls.h:501
coap_opt_filter_t
Definition coap_option.h:101
coap_pdu_t
structure for CoAP PDUs
Definition coap_pdu_internal.h:135
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition coap_session_internal.h:68
coap_socket_t
Definition coap_io_internal.h:38