Session handling functions. More...

#include "coap3/coap_libcoap_build.h"
#include <stdio.h>

Include dependency graph for coap_session.c:

Macros
#define	COAP_SESSION_C_

#define	INET6_ADDRSTRLEN 46

Functions
coap_fixed_point_t	coap_multi_fixed_fixed (coap_fixed_point_t fp1, coap_fixed_point_t fp2)

coap_fixed_point_t	coap_multi_fixed_uint (coap_fixed_point_t fp1, uint32_t u2)

coap_fixed_point_t	coap_add_fixed_fixed (coap_fixed_point_t fp1, coap_fixed_point_t fp2)

coap_fixed_point_t	coap_add_fixed_uint (coap_fixed_point_t fp1, uint32_t u2)

coap_fixed_point_t	coap_sub_fixed_uint (coap_fixed_point_t fp1, uint32_t u2)

coap_fixed_point_t	coap_div_fixed_uint (coap_fixed_point_t fp1, uint32_t u2)

void	coap_session_set_ack_timeout (coap_session_t *session, coap_fixed_point_t value)
	Set the CoAP initial ack response timeout before the next re-transmit. More...

void	coap_session_set_ack_random_factor (coap_session_t *session, coap_fixed_point_t value)
	Set the CoAP ack randomize factor. More...

void	coap_session_set_max_retransmit (coap_session_t *session, uint16_t value)
	Set the CoAP maximum retransmit count before failure. More...

void	coap_session_set_nstart (coap_session_t *session, uint16_t value)
	Set the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART. More...

void	coap_session_set_default_leisure (coap_session_t *session, coap_fixed_point_t value)
	Set the CoAP default leisure time (for multicast) RFC7252 DEFAULT_LEISURE. More...

void	coap_session_set_probing_rate (coap_session_t *session, uint32_t value)
	Set the CoAP probing rate when there is no response RFC7252 PROBING_RATE. More...

void	coap_session_set_max_payloads (coap_session_t *session, uint16_t value)
	Set the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PAYLOADS. More...

void	coap_session_set_non_max_retransmit (coap_session_t *session, uint16_t value)
	Set the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is any response RFC9177 NON_MAX_RETRANSMIT. More...

void	coap_session_set_non_timeout (coap_session_t *session, coap_fixed_point_t value)
	Set the CoAP non timeout delay timeout. More...

void	coap_session_set_non_receive_timeout (coap_session_t *session, coap_fixed_point_t value)
	Set the CoAP non receive timeout delay timeout. More...

coap_fixed_point_t	coap_session_get_ack_timeout (const coap_session_t *session)
	Get the CoAP initial ack response timeout before the next re-transmit. More...

coap_fixed_point_t	coap_session_get_ack_random_factor (const coap_session_t *session)
	Get the CoAP ack randomize factor. More...

uint16_t	coap_session_get_max_retransmit (const coap_session_t *session)
	Get the CoAP maximum retransmit before failure. More...

uint16_t	coap_session_get_nstart (const coap_session_t *session)
	Get the CoAP maximum concurrent transmission count of Confirmable messages RFC7252 NSTART. More...

coap_fixed_point_t	coap_session_get_default_leisure (const coap_session_t *session)
	Get the CoAP default leisure time RFC7252 DEFAULT_LEISURE. More...

uint32_t	coap_session_get_probing_rate (const coap_session_t *session)
	Get the CoAP probing rate when there is no response RFC7252 PROBING_RATE. More...

uint16_t	coap_session_get_max_payloads (const coap_session_t *session)
	Get the CoAP maximum payloads count of Q-Block1 or Q-Block2 before delay is introduced RFC9177 MAX_PAYLOADS. More...

uint16_t	coap_session_get_non_max_retransmit (const coap_session_t *session)
	Get the CoAP NON maximum retransmit count of missing Q-Block1 or Q-Block2 requested before there is any response RFC9177 NON_MAX_RETRANSMIT. More...

coap_fixed_point_t	coap_session_get_non_timeout (const coap_session_t *session)
	Get the CoAP MAX_PAYLOADS limit delay timeout. More...

coap_fixed_point_t	coap_session_get_non_receive_timeout (const coap_session_t *session)
	Get the CoAP non receive timeout delay timeout. More...

COAP_API coap_session_t *	coap_session_reference (coap_session_t *session)
	Increment reference counter on a session. More...

coap_session_t *	coap_session_reference_lkd (coap_session_t *session)
	Increment reference counter on a session. More...

COAP_API void	coap_session_release (coap_session_t *session)
	Decrement reference counter on a session. More...

void	coap_session_release_lkd (coap_session_t *session)
	Decrement reference counter on a session. More...

void	coap_session_set_app_data (coap_session_t session, void app_data)
	Stores `data` with the given session. More...

void *	coap_session_get_app_data (const coap_session_t *session)
	Returns any application-specific data that has been stored with `session` using the function coap_session_set_app_data(). More...

static coap_session_t *	coap_make_session (coap_proto_t proto, coap_session_type_t type, const coap_addr_hash_t addr_hash, const coap_address_t local_addr, const coap_address_t remote_addr, int ifindex, coap_context_t context, coap_endpoint_t *endpoint)

void	coap_session_mfree (coap_session_t *session)

void	coap_session_free (coap_session_t *session)

static size_t	coap_session_max_pdu_size_internal (const coap_session_t *session, size_t max_with_header)

size_t	coap_session_max_pdu_rcv_size (const coap_session_t *session)
	Get maximum acceptable receive PDU size. More...

COAP_API size_t	coap_session_max_pdu_size (const coap_session_t *session)
	Get maximum acceptable PDU size. More...

size_t	coap_session_max_pdu_size_lkd (const coap_session_t *session)
	Get maximum acceptable PDU size. More...

void	coap_session_set_mtu (coap_session_t *session, unsigned mtu)
	Set the session MTU. More...

ssize_t	coap_session_delay_pdu (coap_session_t session, coap_pdu_t pdu, coap_queue_t *node)

void	coap_session_send_csm (coap_session_t *session)
	Notify session transport has just connected and CSM exchange can now start. More...

COAP_API coap_mid_t	coap_session_send_ping (coap_session_t *session)
	Send a ping message for the session. More...

coap_mid_t	coap_session_send_ping_lkd (coap_session_t *session)
	Send a ping message for the session. More...

void	coap_session_connected (coap_session_t *session)
	Notify session that it has just connected or reconnected. More...

static const char *	coap_nack_name (coap_nack_reason_t reason)

void	coap_handle_nack (coap_session_t session, coap_pdu_t sent, const coap_nack_reason_t reason, const coap_mid_t mid)

COAP_API void	coap_session_disconnected (coap_session_t *session, coap_nack_reason_t reason)
	Notify session that it has failed. More...

void	coap_session_disconnected_lkd (coap_session_t *session, coap_nack_reason_t reason)
	Notify session that it has failed. More...

void	coap_session_establish (coap_session_t *session)
	Layer function interface for layer below session accept/connect being established. More...

int	coap_session_refresh_psk_hint (coap_session_t session, const coap_bin_const_t psk_hint)
	Refresh the session's current Identity Hint (PSK). More...

int	coap_session_refresh_psk_key (coap_session_t session, const coap_bin_const_t psk_key)
	Refresh the session's current pre-shared key (PSK). More...

int	coap_session_refresh_psk_identity (coap_session_t session, const coap_bin_const_t psk_identity)
	Refresh the session's current pre-shared identity (PSK). More...

const coap_bin_const_t *	coap_session_get_psk_identity (const coap_session_t *session)
	Get the server session's current PSK identity (PSK). More...

const coap_bin_const_t *	coap_session_get_psk_key (const coap_session_t *session)
	Get the session's current pre-shared key (PSK). More...

void	coap_session_init_token (coap_session_t session, size_t len, const uint8_t data)
	Initializes the token value to use as a starting point. More...

void	coap_session_new_token (coap_session_t session, size_t len, uint8_t *data)
	Creates a new token for use. 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...

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

const coap_address_t *	coap_session_get_addr_remote (const coap_session_t *session)
	Get the remote IP address and port from the session. More...

const coap_address_t *	coap_session_get_addr_local (const coap_session_t *session)
	Get the local IP address and port from the session. More...

const coap_address_t *	coap_session_get_addr_mcast (const coap_session_t *session)
	Get the remote multicast IP address and port from the session if the original target IP was multicast. More...

coap_context_t *	coap_session_get_context (const coap_session_t *session)
	Get the session context. More...

coap_proto_t	coap_session_get_proto (const coap_session_t *session)
	Get the session protocol type. More...

coap_session_type_t	coap_session_get_type (const coap_session_t *session)
	Get the session type. More...

coap_session_state_t	coap_session_get_state (const coap_session_t *session)
	Get the session state. More...

int	coap_session_get_ifindex (const coap_session_t *session)
	Get the session if index. More...

void *	coap_session_get_tls (const coap_session_t session, coap_tls_library_t tls_lib)
	Get the session TLS security ptr (TLS type dependent) More...

static const char *	coap_proto_name (coap_proto_t proto)

coap_session_t *	coap_session_get_by_peer (const coap_context_t ctx, const coap_address_t remote_addr, int ifindex)
	Get the session associated with the specified `remote_addr` and `index`. More...

const char *	coap_session_str (const coap_session_t *session)
	Get session description. More...

Detailed Description

Session handling functions.

Definition in file coap_session.c.

Macro Definition Documentation

◆ COAP_SESSION_C_

#define COAP_SESSION_C_

Definition at line 20 of file coap_session.c.

◆ INET6_ADDRSTRLEN

#define INET6_ADDRSTRLEN 46

Definition at line 2255 of file coap_session.c.

Function Documentation

◆ coap_make_session()

static coap_session_t * coap_make_session	(	coap_proto_t	proto,
		coap_session_type_t	type,
		const coap_addr_hash_t *	addr_hash,
		const coap_address_t *	local_addr,
		const coap_address_t *	remote_addr,
		int	ifindex,
		coap_context_t *	context,
		coap_endpoint_t *	endpoint
	)

static

Definition at line 411 of file coap_session.c.

Here is the call graph for this function:

◆ coap_nack_name()

static const char * coap_nack_name ( coap_nack_reason_t reason )

static

Definition at line 880 of file coap_session.c.

Here is the caller graph for this function:

◆ coap_proto_name()

static const char * coap_proto_name ( coap_proto_t proto )

static

Definition at line 2027 of file coap_session.c.

Here is the caller graph for this function:

◆ coap_session_max_pdu_size_internal()

static size_t coap_session_max_pdu_size_internal	(	const coap_session_t *	session,
		size_t	max_with_header
	)

static

Definition at line 602 of file coap_session.c.

Here is the caller graph for this function:

◆ coap_session_send_ping()

COAP_API coap_mid_t coap_session_send_ping ( coap_session_t * session )

Send a ping message for the session.

Parameters

session The CoAP session.

Returns: COAP_INVALID_MID if there is an error

Definition at line 786 of file coap_session.c.

Here is the call graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ COAP_SESSION_C_

◆ INET6_ADDRSTRLEN

Function Documentation

◆ coap_make_session()

◆ coap_nack_name()

◆ coap_proto_name()

◆ coap_session_max_pdu_size_internal()

◆ coap_session_send_ping()