API for handling PDUs using CoAP Contexts. More...

Collaboration diagram for Context Handling:

Macros
#define	coap_send_large(session, pdu) coap_send(session, pdu)

#define	coap_join_mcast_group(ctx, groupname) (coap_join_mcast_group_intf(ctx, groupname, NULL))

Typedefs
typedef enum coap_response_t	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)
	Response handler that is used as callback in coap_context_t. More...

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)
	Negative Acknowedge handler that is used as callback in coap_context_t. More...

typedef 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. More...

typedef 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. More...

Enumerations
enum	coap_response_t { COAP_RESPONSE_FAIL , COAP_RESPONSE_OK }

Functions
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. More...

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) is dropped after all retries have been exhausted, or a rst message was received, or a network or TLS level event was received that indicates delivering the message is not possible. More...

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. More...

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. More...

COAP_API void	coap_register_option (coap_context_t *ctx, uint16_t type)
	Registers the option type `type` with the given context object `ctx`. More...

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. More...

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. More...

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. More...

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. More...

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. More...

void	coap_context_set_keepalive (coap_context_t *context, unsigned int seconds)
	Set the context keepalive timer for sessions. More...

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. More...

void	coap_context_set_max_token_size (coap_context_t *context, size_t max_token_size)
	Set the maximum token size (RFC8974). More...

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 event in an application's epoll_wait() call. More...

void	coap_context_set_max_idle_sessions (coap_context_t *context, unsigned int max_idle_sessions)
	Set the maximum idle sessions count. More...

unsigned int	coap_context_get_max_idle_sessions (const coap_context_t *context)
	Get the maximum idle sessions count. More...

void	coap_context_set_session_timeout (coap_context_t *context, unsigned int session_timeout)
	Set the session timeout value. More...

unsigned int	coap_context_get_session_timeout (const coap_context_t *context)
	Get the session timeout value. More...

COAP_DEPRECATED void	coap_context_set_csm_timeout (coap_context_t *context, unsigned int csm_timeout)
	Set the CSM timeout value. More...

COAP_DEPRECATED unsigned int	coap_context_get_csm_timeout (const coap_context_t *context)
	Get the CSM timeout value. More...

void	coap_context_set_csm_timeout_ms (coap_context_t *context, unsigned int csm_timeout_ms)
	Set the CSM timeout value. More...

unsigned int	coap_context_get_csm_timeout_ms (const coap_context_t *context)
	Get the CSM timeout value. More...

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. More...

uint32_t	coap_context_get_csm_max_message_size (const coap_context_t *context)
	Get the CSM max session size value. More...

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. More...

unsigned int	coap_context_get_max_handshake_sessions (const coap_context_t *context)
	Get the session timeout value. More...

COAP_API uint16_t	coap_new_message_id (coap_session_t *session)
	Returns a new message id and updates `session->tx_mid` accordingly. More...

COAP_API void	coap_free_context (coap_context_t *context)
	CoAP stack context must be released with coap_free_context(). More...

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)
	Creates a new ACK PDU with specified error `code`. More...

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`. More...

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). More...

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`. More...

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`. More...

COAP_API coap_mid_t	coap_send (coap_session_t session, coap_pdu_t pdu)
	Sends a CoAP message to given peer. More...

COAP_API int	coap_send_recv (coap_session_t session, coap_pdu_t request_pdu, coap_pdu_t **response_pdu, uint32_t timeout_ms)

void	coap_send_recv_terminate (void)
	Terminate any active coap_send_recv() sessions. More...

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`. More...

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. More...

void	coap_ticks (coap_tick_t *)
	Returns the current value of an internal tick counter. More...

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 that are UDP. More...

int	coap_mcast_set_hops (coap_session_t *session, size_t hops)
	Function interface for defining the hop count (ttl) for sending multicast traffic. More...

void	coap_mcast_per_resource (coap_context_t *context)
	Function interface to enable processing mcast requests on a per resource basis. More...

void	coap_context_set_app_data (coap_context_t context, void data)
	Stores `data` with the given context. More...

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_context_set_app_data(). More...

Detailed Description

API for handling PDUs using CoAP Contexts.

Macro Definition Documentation

◆ coap_join_mcast_group

#define coap_join_mcast_group	(	ctx,
		groupname
	)	(coap_join_mcast_group_intf(ctx, groupname, NULL))

Definition at line 608 of file coap_net.h.

◆ coap_send_large

#define coap_send_large	(	session,
		pdu
	)	coap_send(session, pdu)

Definition at line 529 of file coap_net.h.

Typedef Documentation

◆ coap_nack_handler_t

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)

Negative Acknowedge handler that is used as callback in coap_context_t.

Parameters

session	CoAP session.
sent	The PDU that was transmitted.
reason	The reason for the NACK.
mid	CoAP message ID.

Definition at line 77 of file coap_net.h.

◆ coap_ping_handler_t

typedef 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.

Parameters

session	CoAP session.
received	The PDU that was received.
mid	CoAP message ID.

Definition at line 89 of file coap_net.h.

◆ coap_pong_handler_t

typedef 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.

Parameters

session	CoAP session.
received	The PDU that was received.
mid	CoAP message ID.

Definition at line 100 of file coap_net.h.

◆ coap_response_handler_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)

Response handler that is used as callback in coap_context_t.

Parameters

session	CoAP session.
sent	The PDU that was transmitted.
received	The PDU that was received.
mid	CoAP transaction ID.

Returns: COAP_RESPONSE_OK if successful, else COAP_RESPONSE_FAIL which triggers sending a RST packet if the received PDU is a CON or NON.

Definition at line 64 of file coap_net.h.

◆ coap_response_t

typedef enum coap_response_t coap_response_t

Enumeration Type Documentation

◆ coap_response_t

enum coap_response_t

Enumerator
COAP_RESPONSE_FAIL	Response not liked - send CoAP RST packet.
COAP_RESPONSE_OK	Response is fine.

Definition at line 48 of file coap_net.h.

Function Documentation

◆ 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.

Parameters

context The CoAP context to check.

Returns: 0 if there are still pending transmits else 1 if nothing queued for transmission. Note that 0 does not mean there has been a response to a transmitted request.

Definition at line 4543 of file coap_net.c.

Here is the call graph for this function:

◆ 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_context_set_app_data().

This function will return NULL if no data has been stored.

Parameters

context The CoAP context.

Returns: Pointer to the stored data or NULL.

Definition at line 636 of file coap_net.c.

◆ 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 event in an application's epoll_wait() call.

Parameters

context The coap_context_t object.

Returns: The libcoap file descriptor or -1 if epoll is not available.

Definition at line 557 of file coap_net.c.

◆ 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.

Parameters

context The coap_context_t object.

Returns: The CSM max session size value.

Definition at line 541 of file coap_net.c.

◆ coap_context_get_csm_timeout()

COAP_DEPRECATED unsigned int coap_context_get_csm_timeout ( const coap_context_t * context )

Get the CSM timeout value.

Parameters

context The coap_context_t object.

Returns: The CSM timeout value.

Deprecated:: Use coap_context_get_csm_timeout_ms() instead.

Definition at line 513 of file coap_net.c.

◆ coap_context_get_csm_timeout_ms()

unsigned int coap_context_get_csm_timeout_ms ( const coap_context_t * context )

Get the CSM timeout value.

Parameters

context The coap_context_t object.

Returns: The CSM timeout value in millisecs.

Definition at line 529 of file coap_net.c.

◆ coap_context_get_max_handshake_sessions()

unsigned int coap_context_get_max_handshake_sessions ( const coap_context_t * context )

Get the session timeout value.

Parameters

context The coap_context_t object.

Returns: The maximim number of sessions in (D)TLS handshake value.

Definition at line 499 of file coap_net.c.

◆ 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.

Parameters

context The coap_context_t object.

Returns: The count of max idle sessions.

Definition at line 488 of file coap_net.c.

◆ coap_context_get_session_timeout()

unsigned int coap_context_get_session_timeout ( const coap_context_t * context )

Get the session timeout value.

Parameters

context The coap_context_t object.

Returns: The session timeout value.

Definition at line 552 of file coap_net.c.

◆ coap_context_set_app_data()

void coap_context_set_app_data	(	coap_context_t *	context,
		void *	data
	)

Stores data with the given context.

This function overwrites any value that has previously been stored with context.

Parameters

context	The CoAP context.
data	The pointer to the data to store.

Definition at line 630 of file coap_net.c.

◆ 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.

Parameters

context	The coap_context_t object.
every	Change the client's source port `every` packets sent.

Returns: 1 if frequency change set (CID supported), else 0.

Definition at line 463 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

The largest PDU that can be received.

Parameters

context	The coap_context_t object.
csm_max_message_size	The CSM max message size value.

Definition at line 534 of file coap_net.c.

◆ 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.

The number of seconds to wait for a (TCP) CSM negotiation response from the peer. 0 (the default) means use wait forever.

Parameters

context	The coap_context_t object.
csm_timeout	The CSM timeout value.

Deprecated:: Use coap_context_set_csm_timeout_ms() instead.

Definition at line 506 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

The number of milliseconds to wait for a (TCP) CSM negotiation response from the peer. The initial default is 1000 milliseconds.

Parameters

context	The coap_context_t object.
csm_timeout_ms	The CSM timeout value in milliseconds (which could get updated to be in the range of 10 - 10000 milliseconds).

Definition at line 519 of file coap_net.c.

Here is the caller graph for this function:

◆ coap_context_set_keepalive()

void coap_context_set_keepalive	(	coap_context_t *	context,
		unsigned int	seconds
	)

Set the context keepalive timer for sessions.

A keepalive message will be sent after if a session has been inactive, i.e. no packet sent or received, for the given number of seconds. For unreliable protocols, a CoAP Empty message will be sent. If a CoAP RST is not received, the CoAP Empty messages will get resent based on the Confirmable retry parameters until there is a failure timeout, at which point the session will be considered as disconnected. For reliable protocols, a CoAP PING message will be sent. If a CoAP PONG has not been received before the next PING is due to be sent, the session will be considered as disconnected.

Parameters

context	The coap_context_t object.
seconds	Number of seconds for the inactivity timer, or zero to disable CoAP-level keepalive messages.

Definition at line 458 of file coap_net.c.

◆ 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.

If this number is exceeded, the least recently used server session in handshake is completely removed. 0 (the default) means that the number is not monitored.

Parameters

context	The coap_context_t object.
max_handshake_sessions	The maximum number of sessions in handshake.

Definition at line 493 of file coap_net.c.

◆ 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.

The number of server sessions that are currently not in use. If this number is exceeded, the least recently used server session is completely removed. 0 (the default) means that the number is not monitored.

Parameters

context	The coap_context_t object.
max_idle_sessions	The maximum idle session count.

Definition at line 482 of file coap_net.c.

◆ 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).

Parameters

context	The coap_context_t object.
max_token_size	The maximum token size. A value between 8 and 65804 inclusive.

Definition at line 474 of file coap_net.c.

◆ 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.

Parameters

context	The current coap_context_t object.
setup_data	If NULL, PKI authentication will fail. Certificate information required.

Returns: 1 if successful, else 0.

◆ 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.

Parameters

context	The current coap_context_t object.
ca_file	If not NULL, is the full path name of a PEM encoded file containing all the Root CAs to be used.
ca_dir	If not NULL, points to a directory containing PEM encoded files containing all the Root CAs to be used.

Returns: 1 if successful, else 0.

Definition at line 436 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

Deprecated:: Use coap_context_set_psk2() instead.

Parameters

context	The current coap_context_t object.
hint	The default PSK server hint sent to a client. If NULL, PSK authentication is disabled. Empty string is a valid hint.
key	The default PSK key. If NULL, PSK authentication will fail.
key_len	The default PSK key's length. If `0`, PSK authentication will fail.

Returns: 1 if successful, else 0.

◆ 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.

Parameters

context	The current coap_context_t object.
setup_data	If NULL, PSK authentication will fail. PSK information required.

Returns: 1 if successful, else 0.

◆ coap_context_set_session_timeout()

void coap_context_set_session_timeout	(	coap_context_t *	context,
		unsigned int	session_timeout
	)

Set the session timeout value.

The number of seconds of inactivity after which an unused server session will be closed. 0 means use default (300 secs).

Parameters

context	The coap_context_t object.
session_timeout	The session timeout value.

Definition at line 546 of file coap_net.c.

◆ coap_free_context()

COAP_API void coap_free_context ( coap_context_t * context )

CoAP stack context must be released with coap_free_context().

This function clears all entries from the receive queue and send queue and deletes the resources that have been registered with context, and frees the attached endpoints.

Parameters

context The current coap_context_t object to free off.

Definition at line 746 of file coap_net.c.

Here is the call graph for this function:

◆ coap_get_app_data()

void * coap_get_app_data ( const coap_context_t * context )

Deprecated:: Use coap_context_get_app_data() instead.

Returns any application-specific data that has been stored with context using the function coap_set_app_data(). This function will return NULL if no data has been stored.

Parameters

context The CoAP context.

Returns: The data previously stored or NULL if not data stored.

Definition at line 740 of file coap_net.c.

◆ 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.

Parameters

context	The CoAP context whose event handler is to be called.
event	The event to deliver.
session	The session related to `event`.

Returns: The result from the associated event handler or 0 if none was registered.

Definition at line 4480 of file coap_net.c.

Here is the call graph for this function:

◆ 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 that are UDP.

Parameters

ctx	The current context.
groupname	The name of the group that is to be joined for listening.
ifname	Network interface to join the group on, or NULL if first appropriate interface is to be chosen by the O/S.

Returns: 0 on success, -1 on error

◆ 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.

This then enables a set of configuration flags set up when configuring the resources (coap_resource_init()).

Parameters

context The current context.

◆ 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.

The default is 1 so that the ttl expires after decrementing if the packet is trying to pass out of the local network.

Parameters

session	The current session.
hops	The number of hops (ttl) to use before the multicast packet expires.

Returns: 1 on success, 0 on error

◆ 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 at line 642 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

The options specified by the filter expression opts will be copied from the original request contained in request. Unless SHORT_ERROR_RESPONSE was defined at build time, the textual reason phrase for code will be added as payload, with Content-Type 0. This function returns a pointer to the new response message, or NULL on error. The storage allocated for the new message must be released with coap_free().

Parameters

request	Specification of the received (confirmable) request.
code	The error code to set.
opts	An option filter that specifies which options to copy from the original request in `node`.

Returns: A pointer to the new message or NULL on error.

Definition at line 2790 of file coap_net.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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.

The message id is returned in network byte order to make it easier to read in tracing tools.

Parameters

session The current coap_session_t object.

Returns: Incremented message id in network byte order.

Definition at line 1923 of file coap_session.c.

Here is the call graph for this function:

◆ 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) is dropped after all retries have been exhausted, or a rst message was received, or a network or TLS level event was received that indicates delivering the message is not possible.

Parameters

context	The context to register the handler for.
handler	The nack handler to register.

Definition at line 4691 of file coap_net.c.

◆ 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.

Parameters

ctx	The context to use.
type	The option type to register.

Definition at line 4709 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

Parameters

context	The context to register the handler for.
handler	The ping handler to register.

Definition at line 4697 of file coap_net.c.

◆ 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.

Parameters

context	The context to register the handler for.
handler	The pong handler to register.

Definition at line 4703 of file coap_net.c.

◆ 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.

Parameters

context	The context to register the handler for.
handler	The response handler to register.

Definition at line 4680 of file coap_net.c.

◆ coap_send()

COAP_API coap_mid_t coap_send	(	coap_session_t *	session,
		coap_pdu_t *	pdu
	)

Sends a CoAP message to given peer.

The memory that is allocated for the pdu will be released by coap_send(). The caller must not use or delete the pdu after calling coap_send().

Parameters

session	The CoAP session.
pdu	The CoAP PDU to send.

Returns: The message id of the sent message or COAP_INVALID_MID on error.

Definition at line 1346 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

This function returns the corresponding message id if the message was sent or COAP_INVALID_MID on error.

Parameters

session	The CoAP session.
request	The request to be acknowledged.

Returns: The message id if ACK was sent or COAP_INVALID_MID on error.

Definition at line 976 of file coap_net.c.

Here is the call graph for this function:

◆ 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.

opts will be passed to coap_new_error_response() to copy marked options from the request. This function returns the message id if the message was sent, or COAP_INVALID_MID otherwise.

Parameters

session	The CoAP session.
request	The original request to respond to.
code	The response code.
opts	A filter that specifies the options to copy from the `request`.

Returns: The message id if the message was sent, or COAP_INVALID_MID otherwise.

Definition at line 1053 of file coap_net.c.

Here is the call graph for this function:

◆ 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).

This function returns COAP_INVALID_MID when the message was not sent, a valid transaction id otherwise.

Parameters

session	The CoAP session.
request	The request that should be responded to.
type	Which type to set.

Returns: message id on success or COAP_INVALID_MID otherwise.

Definition at line 1084 of file coap_net.c.

Here is the call graph for this function:

◆ coap_send_recv()

COAP_API int coap_send_recv	(	coap_session_t *	session,
		coap_pdu_t *	request_pdu,
		coap_pdu_t **	response_pdu,
		uint32_t	timeout_ms
	)

Definition at line 1916 of file coap_net.c.

Here is the call graph for this function:

◆ coap_send_recv_terminate()

void coap_send_recv_terminate ( void )

Terminate any active coap_send_recv() sessions.

Definition at line 1911 of file coap_net.c.

◆ 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.

This function returns the corresponding message id if the message was sent or COAP_INVALID_MID on error.

Parameters

session	The CoAP session.
request	The request to be reset.

Returns: The message id if RST was sent or COAP_INVALID_MID on error.

Definition at line 961 of file coap_net.c.

Here is the call graph for this function:

◆ coap_set_app_data()

void coap_set_app_data	(	coap_context_t *	context,
		void *	data
	)

Deprecated:: Use coap_context_set_app_data() instead.

Stores data with the given CoAP context. This function overwrites any value that has previously been stored with context.

Parameters

context	The CoAP context.
data	The data to store with wih the context. Note that this data must be valid during the lifetime of `context`.

Definition at line 734 of file coap_net.c.

◆ coap_ticks()

void coap_ticks ( coap_tick_t * )

Returns the current value of an internal tick counter.

The counter counts COAP_TICKS_PER_SECOND ticks every second.

Here is the caller graph for this function:

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ coap_join_mcast_group

◆ coap_send_large

Typedef Documentation

◆ coap_nack_handler_t

◆ coap_ping_handler_t

◆ coap_pong_handler_t

◆ coap_response_handler_t

◆ coap_response_t

Enumeration Type Documentation

◆ coap_response_t

Function Documentation

◆ coap_can_exit()

◆ coap_context_get_app_data()

◆ coap_context_get_coap_fd()

◆ coap_context_get_csm_max_message_size()

◆ coap_context_get_csm_timeout()

◆ coap_context_get_csm_timeout_ms()

◆ coap_context_get_max_handshake_sessions()

◆ coap_context_get_max_idle_sessions()

◆ coap_context_get_session_timeout()

◆ coap_context_set_app_data()

◆ coap_context_set_cid_tuple_change()

◆ coap_context_set_csm_max_message_size()

◆ coap_context_set_csm_timeout()

◆ coap_context_set_csm_timeout_ms()

◆ coap_context_set_keepalive()

◆ coap_context_set_max_handshake_sessions()

◆ coap_context_set_max_idle_sessions()

◆ coap_context_set_max_token_size()

◆ coap_context_set_pki()

◆ coap_context_set_pki_root_cas()

◆ coap_context_set_psk()

◆ coap_context_set_psk2()

◆ coap_context_set_session_timeout()

◆ coap_free_context()

◆ coap_get_app_data()

◆ coap_handle_event()

◆ coap_join_mcast_group_intf()

◆ coap_mcast_per_resource()

◆ coap_mcast_set_hops()

◆ coap_new_context()

◆ coap_new_error_response()

◆ coap_new_message_id()

◆ coap_register_nack_handler()

◆ coap_register_option()

◆ coap_register_ping_handler()

◆ coap_register_pong_handler()

◆ coap_register_response_handler()

◆ coap_send()

◆ coap_send_ack()

◆ coap_send_error()

◆ coap_send_message_type()

◆ coap_send_recv()

◆ coap_send_recv_terminate()

◆ coap_send_rst()

◆ coap_set_app_data()

◆ coap_ticks()