The CoAP stack's global state is stored in a coap_context_t object. More...

#include <coap_net_internal.h>

Collaboration diagram for coap_context_t:

Data Fields
coap_opt_filter_t	known_options

coap_tick_t	sendqueue_basetime
	The time stamp in the first element of the sendqeue is relative to sendqueue_basetime.

coap_queue_t *	sendqueue

coap_nack_handler_t	nack_cb
	Called when a response issue has occurred.

coap_ping_handler_t	ping_cb
	Called when a CoAP ping is received.

coap_pong_handler_t	pong_cb
	Called when a ping response is received.

coap_block_data_handler_t	block_data_cb
	Called with each block data during block transfers.

coap_event_handler_t	event_cb
	Callback function that is used to signal events to the application.

void *	dtls_context

unsigned int	session_timeout
	Number of seconds of inactivity after which an unused session will be closed.

unsigned int	max_idle_sessions
	Maximum number of simultaneous unused sessions per endpoint.

unsigned int	max_handshake_sessions
	Maximum number of simultaneous negotating sessions per endpoint.

unsigned int	ping_timeout
	Minimum inactivity time before sending a ping message.

uint32_t	csm_timeout_ms
	Timeout for waiting for a CSM from the remote side.

uint32_t	csm_max_message_size
	Value for CSM Max-Message-Size.

void *	app_data
	application-specific data

coap_app_data_free_callback_t	app_cb
	call-back to release app_data

uint32_t	max_token_size
	Largest token size supported RFC8974.

coap_tick_t	next_timeout
	When the next timeout is to occur.

coap_socket_t *	sockets [64]
	Track different socket information in coap_io_process_with_fds_lkd()

unsigned int	num_sockets
	Number of sockets being tracked.

uint32_t	block_mode
	Zero or more COAP_BLOCK_ or'd options.

coap_resource_dynamic_create_t	dyn_create_handler
	Dynamc resource create handler.

uint32_t	dynamic_cur
	Current number of dynamic resources.

uint32_t	dynamic_max
	Max number of dynamic resources or 0 is unlimited.

uint32_t	max_body_size
	Max supported body size or 0 is unlimited.

Detailed Description

The CoAP stack's global state is stored in a coap_context_t object.

Definition at line 54 of file coap_net_internal.h.

Field Documentation

◆ app_cb

coap_app_data_free_callback_t coap_context_t::app_cb

call-back to release app_data

Definition at line 190 of file coap_net_internal.h.

◆ app_data

void* coap_context_t::app_data

application-specific data

Definition at line 189 of file coap_net_internal.h.

◆ block_data_cb

coap_block_data_handler_t coap_context_t::block_data_cb

Called with each block data during block transfers.

Definition at line 118 of file coap_net_internal.h.

◆ block_mode

uint32_t coap_context_t::block_mode

Zero or more COAP_BLOCK_ or'd options.

Definition at line 224 of file coap_net_internal.h.

◆ csm_max_message_size

uint32_t coap_context_t::csm_max_message_size

Value for CSM Max-Message-Size.

Definition at line 174 of file coap_net_internal.h.

◆ csm_timeout_ms

uint32_t coap_context_t::csm_timeout_ms

Timeout for waiting for a CSM from the remote side.

Definition at line 172 of file coap_net_internal.h.

◆ dtls_context

void* coap_context_t::dtls_context

Definition at line 153 of file coap_net_internal.h.

◆ dyn_create_handler

coap_resource_dynamic_create_t coap_context_t::dyn_create_handler

Dynamc resource create handler.

Definition at line 225 of file coap_net_internal.h.

◆ dynamic_cur

uint32_t coap_context_t::dynamic_cur

Current number of dynamic resources.

Definition at line 226 of file coap_net_internal.h.

◆ dynamic_max

uint32_t coap_context_t::dynamic_max

Max number of dynamic resources or 0 is unlimited.

Definition at line 227 of file coap_net_internal.h.

◆ event_cb

coap_event_handler_t coap_context_t::event_cb

Callback function that is used to signal events to the application.

This field is set by coap_set_event_handler().

Definition at line 151 of file coap_net_internal.h.

◆ known_options

coap_opt_filter_t coap_context_t::known_options

Definition at line 55 of file coap_net_internal.h.

◆ max_body_size

uint32_t coap_context_t::max_body_size

Max supported body size or 0 is unlimited.

Definition at line 228 of file coap_net_internal.h.

◆ max_handshake_sessions

unsigned int coap_context_t::max_handshake_sessions

Maximum number of simultaneous negotating sessions per endpoint.

0 means use default.

Definition at line 166 of file coap_net_internal.h.

◆ max_idle_sessions

unsigned int coap_context_t::max_idle_sessions

Maximum number of simultaneous unused sessions per endpoint.

0 means no maximum.

Definition at line 163 of file coap_net_internal.h.

◆ max_token_size

uint32_t coap_context_t::max_token_size

Largest token size supported RFC8974.

Definition at line 191 of file coap_net_internal.h.

◆ nack_cb

coap_nack_handler_t coap_context_t::nack_cb

Called when a response issue has occurred.

Definition at line 115 of file coap_net_internal.h.

◆ next_timeout

coap_tick_t coap_context_t::next_timeout

When the next timeout is to occur.

Definition at line 192 of file coap_net_internal.h.

◆ num_sockets

unsigned int coap_context_t::num_sockets

Number of sockets being tracked.

Definition at line 204 of file coap_net_internal.h.

◆ ping_cb

coap_ping_handler_t coap_context_t::ping_cb

Called when a CoAP ping is received.

Definition at line 116 of file coap_net_internal.h.

◆ ping_timeout

unsigned int coap_context_t::ping_timeout

Minimum inactivity time before sending a ping message.

0 means disabled.

Definition at line 169 of file coap_net_internal.h.

◆ pong_cb

coap_pong_handler_t coap_context_t::pong_cb

Called when a ping response is received.

Definition at line 117 of file coap_net_internal.h.

◆ sendqueue

coap_queue_t* coap_context_t::sendqueue

Definition at line 79 of file coap_net_internal.h.

◆ sendqueue_basetime

coap_tick_t coap_context_t::sendqueue_basetime

The time stamp in the first element of the sendqeue is relative to sendqueue_basetime.

Definition at line 78 of file coap_net_internal.h.

◆ session_timeout

unsigned int coap_context_t::session_timeout

Number of seconds of inactivity after which an unused session will be closed.