Internal API for handling Sessions. More...

Collaboration diagram for Sessions:

Data Structures
struct	coap_addr_hash_t
	Only used for servers for hashing incoming packets. More...

struct	coap_session_t
	Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (server). More...

struct	coap_endpoint_t
	Abstraction of virtual endpoint that can be attached to coap_context_t. More...

Macros
#define	COAP_SESSION_REF(s) ((s)->ref

#define	COAP_ACK_TIMEOUT(s) ((s)->ack_timeout)

#define	COAP_ACK_RANDOM_FACTOR(s) ((s)->ack_random_factor)

#define	COAP_MAX_RETRANSMIT(s) ((s)->max_retransmit)

#define	COAP_NSTART(s) ((s)->nstart)

#define	COAP_DEFAULT_LEISURE(s) ((s)->default_leisure)

#define	COAP_PROBING_RATE(s) ((s)->probing_rate)

#define	COAP_MAX_PAYLOADS(s) ((s)->max_payloads)

#define	COAP_NON_MAX_RETRANSMIT(s) ((s)->non_max_retransmit)

#define	COAP_NON_TIMEOUT(s) ((s)->non_timeout)

#define	COAP_NON_TIMEOUT_TICKS(s)

#define	COAP_NON_RECEIVE_TIMEOUT(s) ((s)->non_receive_timeout)

#define	COAP_NON_PROBING_WAIT_BASE(s) ((s)->non_probing_wait_base)

#define	COAP_NON_PARTIAL_TIMEOUT(s) ((s)->non_partial_timeout)

#define	COAP_DEFAULT_LEISURE_TICKS(s)
	The DEFAULT_LEISURE definition for the session (s).

#define	COAP_MAX_TRANSMIT_SPAN(s)
	The MAX_TRANSMIT_SPAN definition for the session (s).

#define	COAP_MAX_TRANSMIT_WAIT(s)
	The MAX_TRANSMIT_WAIT definition for the session (s).

#define	COAP_MAX_TRANSMIT_WAIT_TICKS(s) (COAP_MAX_TRANSMIT_WAIT(s) * COAP_TICKS_PER_SECOND)

#define	COAP_PROCESSING_DELAY(s)
	The PROCESSING_DELAY definition for the session (s).

#define	COAP_MAX_RTT(s) ((2 * COAP_DEFAULT_MAX_LATENCY) + COAP_PROCESSING_DELAY(s))
	The MAX_RTT definition for the session (s).

#define	COAP_EXCHANGE_LIFETIME(s)
	The EXCHANGE_LIFETIME definition for the session (s).

#define	COAP_NON_LIFETIME(s) (COAP_MAX_TRANSMIT_SPAN(s) + COAP_DEFAULT_MAX_LATENCY)
	The NON_LIFETIME definition for the session (s).

#define	COAP_NON_RECEIVE_TIMEOUT_TICKS(s)
	The NON_RECEIVE_TIMEOUT definition for the session (s).

#define	COAP_NON_PROBING_WAIT(s)
	The NON_PROBING_WAIT definition for the session (s).

#define	COAP_NON_PROBING_WAIT_TICKS(s)

#define	COAP_NON_PARTIAL_TIMEOUT_TICKS(s)
	The NON_PARTIAL_TIMEOUT definition for the session (s).

#define	COAP_NON_TIMEOUT_RANDOM(s) coap_get_non_timeout_random(s)
	The NON_TIMEOUT_RANDOM definition for the session (s).

Typedefs
typedef enum coap_ext_token_check_t	coap_ext_token_check_t
	coap_ext_token_check_t values

Enumerations
enum	COAP_OSCORE_B_2_STEP { COAP_OSCORE_B_2_NONE = 0 , COAP_OSCORE_B_2_STEP_1 , COAP_OSCORE_B_2_STEP_2 , COAP_OSCORE_B_2_STEP_3 , COAP_OSCORE_B_2_STEP_4 , COAP_OSCORE_B_2_STEP_5 }

enum	coap_ext_token_check_t { COAP_EXT_T_NOT_CHECKED = 0 , COAP_EXT_T_CHECKED , COAP_EXT_T_CHECKING }
	coap_ext_token_check_t values More...

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)

coap_fixed_point_t	coap_get_non_timeout_random (coap_session_t *session)

coap_tick_t	coap_get_non_timeout_random_ticks (coap_session_t *session)

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

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

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

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

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

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

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

coap_session_t *	coap_new_server_session (coap_context_t ctx, coap_endpoint_t ep, void *extra)
	Creates a new server session for the specified endpoint.

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

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

int	coap_session_set_type_client_lkd (coap_session_t *session)
	Set the session type to client.

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

ssize_t	coap_session_send_pdu (coap_session_t session, coap_pdu_t pdu)
	Send a pdu according to the session's protocol.

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

coap_session_t *	coap_endpoint_get_session (coap_endpoint_t endpoint, const coap_packet_t packet, coap_tick_t now)
	Lookup the server session for the packet received on an endpoint, or create a new one.

coap_endpoint_t *	coap_new_endpoint_lkd (coap_context_t context, const coap_address_t listen_addr, coap_proto_t proto)
	Create a new endpoint for communicating with peers.

void	coap_free_endpoint_lkd (coap_endpoint_t *endpoint)
	Release an endpoint and all the structures associated with it.

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

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

coap_session_t *	coap_new_client_session_lkd (coap_context_t ctx, const coap_address_t local_if, const coap_address_t *server, coap_proto_t proto)
	Creates a new client session to the designated server.

coap_session_t *	coap_new_client_session_pki_lkd (coap_context_t ctx, const coap_address_t local_if, const coap_address_t server, coap_proto_t proto, coap_dtls_pki_t setup_data)
	Creates a new client session to the designated server with PKI credentials.

coap_session_t *	coap_new_client_session_psk_lkd (coap_context_t ctx, const coap_address_t local_if, const coap_address_t server, coap_proto_t proto, const char identity, const uint8_t *key, unsigned key_len)
	Creates a new client session to the designated server with PSK credentials.

coap_session_t *	coap_new_client_session_psk2_lkd (coap_context_t ctx, const coap_address_t local_if, const coap_address_t server, coap_proto_t proto, coap_dtls_cpsk_t setup_data)
	Creates a new client session to the designated server with PSK credentials.

int	coap_session_reconnect (coap_session_t *session)
	Close the current session (if not already closed) and reconnect to server (client session only).

void	coap_session_server_keepalive_failed (coap_session_t *session)
	Clear down a session following a keepalive failure.

void *	coap_session_set_app_data2_lkd (coap_session_t session, void data, coap_app_data_free_callback_t callback)
	Stores `data` with the given session, returning the previously stored value or NULL.

void	coap_session_free (coap_session_t *session)

void	coap_session_mfree (coap_session_t *session)

void	coap_read_session (coap_context_t ctx, coap_session_t session, coap_tick_t now)

void	coap_connect_session (coap_session_t *session, coap_tick_t now)

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

void	coap_session_failed (coap_session_t *session)
	Session has failed due to a socket error.

void	coap_session_reestablished (coap_session_t *session)
	Session has been re-connected to server.

Detailed Description

Internal API for handling Sessions.

Macro Definition Documentation

◆ COAP_ACK_RANDOM_FACTOR

#define COAP_ACK_RANDOM_FACTOR ( s ) ((s)->ack_random_factor)

Definition at line 684 of file coap_session_internal.h.

◆ COAP_ACK_TIMEOUT

#define COAP_ACK_TIMEOUT ( s ) ((s)->ack_timeout)

Definition at line 683 of file coap_session_internal.h.

◆ COAP_DEFAULT_LEISURE

#define COAP_DEFAULT_LEISURE ( s ) ((s)->default_leisure)

Definition at line 687 of file coap_session_internal.h.

◆ COAP_DEFAULT_LEISURE_TICKS

#define COAP_DEFAULT_LEISURE_TICKS ( s )

Value:

(COAP_DEFAULT_LEISURE(s).integer_part * COAP_TICKS_PER_SECOND + \

COAP_DEFAULT_LEISURE(s).fractional_part * COAP_TICKS_PER_SECOND / 1000)

COAP_TICKS_PER_SECOND

#define COAP_TICKS_PER_SECOND

Use ms resolution on POSIX systems.

Definition coap_time.h:158

COAP_DEFAULT_LEISURE

#define COAP_DEFAULT_LEISURE(s)

Definition coap_session_internal.h:687

The DEFAULT_LEISURE definition for the session (s).

RFC 7252, Section 4.8 Initial value 5.0 seconds

Definition at line 706 of file coap_session_internal.h.

◆ COAP_EXCHANGE_LIFETIME

#define COAP_EXCHANGE_LIFETIME ( s )

Value:

(COAP_MAX_TRANSMIT_SPAN(s) + (2 * COAP_DEFAULT_MAX_LATENCY) + \

COAP_PROCESSING_DELAY(s))

COAP_DEFAULT_MAX_LATENCY

#define COAP_DEFAULT_MAX_LATENCY

The MAX_LATENCY definition.

Definition coap_session.h:584

COAP_PROCESSING_DELAY

#define COAP_PROCESSING_DELAY(s)

The PROCESSING_DELAY definition for the session (s).

Definition coap_session_internal.h:744

COAP_MAX_TRANSMIT_SPAN

#define COAP_MAX_TRANSMIT_SPAN(s)

The MAX_TRANSMIT_SPAN definition for the session (s).

Definition coap_session_internal.h:715

The EXCHANGE_LIFETIME definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of EXCHANGE_LIFETIME MAX_TRANSMIT_SPAN + (2 * MAX_LATENCY) + PROCESSING_DELAY

Definition at line 763 of file coap_session_internal.h.

◆ COAP_MAX_PAYLOADS

#define COAP_MAX_PAYLOADS ( s ) ((s)->max_payloads)

Definition at line 690 of file coap_session_internal.h.

◆ COAP_MAX_RETRANSMIT

#define COAP_MAX_RETRANSMIT ( s ) ((s)->max_retransmit)

Definition at line 685 of file coap_session_internal.h.

◆ COAP_MAX_RTT

#define COAP_MAX_RTT ( s ) ((2 * COAP_DEFAULT_MAX_LATENCY) + COAP_PROCESSING_DELAY(s))

The MAX_RTT definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of MAX_RTT (2 * MAX_LATENCY) + PROCESSING_DELAY

Definition at line 754 of file coap_session_internal.h.

◆ COAP_MAX_TRANSMIT_SPAN

#define COAP_MAX_TRANSMIT_SPAN ( s )

Value:

  (((s)->ack_timeout.integer_part * 1000 + (s)->ack_timeout.fractional_part) * \
   ((1 << ((s)->max_retransmit)) -1) * \
   ((s)->ack_random_factor.integer_part * 1000 + \
    (s)->ack_random_factor.fractional_part) \
   / 1000000)

The MAX_TRANSMIT_SPAN definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of MAX_TRAMSMIT_SPAN ACK_TIMEOUT * ((2 ** (MAX_RETRANSMIT)) - 1) * ACK_RANDOM_FACTOR

Definition at line 715 of file coap_session_internal.h.

◆ COAP_MAX_TRANSMIT_WAIT

#define COAP_MAX_TRANSMIT_WAIT ( s )

Value:

  (((s)->ack_timeout.integer_part * 1000 + (s)->ack_timeout.fractional_part) * \
   ((1 << ((s)->max_retransmit + 1)) -1) * \
   ((s)->ack_random_factor.integer_part * 1000 + \
    (s)->ack_random_factor.fractional_part) \
   / 1000000)

The MAX_TRANSMIT_WAIT definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of MAX_TRAMSMIT_WAIT ACK_TIMEOUT * ((2 ** (MAX_RETRANSMIT + 1)) - 1) * ACK_RANDOM_FACTOR

Definition at line 728 of file coap_session_internal.h.

◆ COAP_MAX_TRANSMIT_WAIT_TICKS

#define COAP_MAX_TRANSMIT_WAIT_TICKS ( s ) (COAP_MAX_TRANSMIT_WAIT(s) * COAP_TICKS_PER_SECOND)

Definition at line 735 of file coap_session_internal.h.

◆ COAP_NON_LIFETIME

#define COAP_NON_LIFETIME ( s ) (COAP_MAX_TRANSMIT_SPAN(s) + COAP_DEFAULT_MAX_LATENCY)

The NON_LIFETIME definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of NON_LIFETIME MAX_TRANSMIT_SPAN + MAX_LATENCY

Definition at line 773 of file coap_session_internal.h.

◆ COAP_NON_MAX_RETRANSMIT

#define COAP_NON_MAX_RETRANSMIT ( s ) ((s)->non_max_retransmit)

Definition at line 691 of file coap_session_internal.h.

◆ COAP_NON_PARTIAL_TIMEOUT

#define COAP_NON_PARTIAL_TIMEOUT ( s ) ((s)->non_partial_timeout)

Definition at line 698 of file coap_session_internal.h.

◆ COAP_NON_PARTIAL_TIMEOUT_TICKS

#define COAP_NON_PARTIAL_TIMEOUT_TICKS ( s )

Value:

(COAP_NON_PARTIAL_TIMEOUT(s).integer_part * COAP_TICKS_PER_SECOND + \

COAP_NON_PARTIAL_TIMEOUT(s).fractional_part * COAP_TICKS_PER_SECOND / 1000)

COAP_NON_PARTIAL_TIMEOUT

#define COAP_NON_PARTIAL_TIMEOUT(s)

Definition coap_session_internal.h:698

The NON_PARTIAL_TIMEOUT definition for the session (s).

RFC9177 Section 6.2 Initial value EXCHANGE_LIFETIME (247 seconds)

Definition at line 808 of file coap_session_internal.h.

◆ COAP_NON_PROBING_WAIT

#define COAP_NON_PROBING_WAIT ( s )

Value:

coap_add_fixed_fixed(COAP_NON_PROBING_WAIT_BASE(s), \

COAP_NON_TIMEOUT_RANDOM(s))

COAP_NON_PROBING_WAIT_BASE

#define COAP_NON_PROBING_WAIT_BASE(s)

Definition coap_session_internal.h:697

COAP_NON_TIMEOUT_RANDOM

#define COAP_NON_TIMEOUT_RANDOM(s)

The NON_TIMEOUT_RANDOM definition for the session (s).

Definition coap_session_internal.h:818

coap_add_fixed_fixed

coap_fixed_point_t coap_add_fixed_fixed(coap_fixed_point_t fp1, coap_fixed_point_t fp2)

Definition coap_session.c:50

The NON_PROBING_WAIT definition for the session (s).

RFC9177 Section 6.2 NON_PROBING_WAIT = NON_TIMEOUT * ((2 ** NON_MAX_RETRANSMIT) - 1) * ACK_RANDOM_FACTOR + (2 * MAX_LATENCY) + NON_TIMEOUT_RANDOM Default is 247-248 seconds

Definition at line 794 of file coap_session_internal.h.

◆ COAP_NON_PROBING_WAIT_BASE

#define COAP_NON_PROBING_WAIT_BASE ( s ) ((s)->non_probing_wait_base)

Definition at line 697 of file coap_session_internal.h.

◆ COAP_NON_PROBING_WAIT_TICKS

#define COAP_NON_PROBING_WAIT_TICKS ( s )

Value:

(COAP_NON_PROBING_WAIT(s).integer_part * COAP_TICKS_PER_SECOND + \

COAP_NON_PROBING_WAIT(s).fractional_part * COAP_TICKS_PER_SECOND / 1000)

COAP_NON_PROBING_WAIT

#define COAP_NON_PROBING_WAIT(s)

The NON_PROBING_WAIT definition for the session (s).

Definition coap_session_internal.h:794

Definition at line 798 of file coap_session_internal.h.

◆ COAP_NON_RECEIVE_TIMEOUT

#define COAP_NON_RECEIVE_TIMEOUT ( s ) ((s)->non_receive_timeout)

Definition at line 696 of file coap_session_internal.h.

◆ COAP_NON_RECEIVE_TIMEOUT_TICKS

#define COAP_NON_RECEIVE_TIMEOUT_TICKS ( s )

Value:

                                            ( \
                                            COAP_NON_RECEIVE_TIMEOUT(s).integer_part * COAP_TICKS_PER_SECOND + \
                                            COAP_NON_RECEIVE_TIMEOUT(s).fractional_part * COAP_TICKS_PER_SECOND / 1000)

The NON_RECEIVE_TIMEOUT definition for the session (s).

RFC9177 Section 6.2 2 * NON_TIMEOUT

Definition at line 782 of file coap_session_internal.h.

◆ COAP_NON_TIMEOUT

#define COAP_NON_TIMEOUT ( s ) ((s)->non_timeout)

Definition at line 692 of file coap_session_internal.h.

◆ COAP_NON_TIMEOUT_RANDOM

#define COAP_NON_TIMEOUT_RANDOM ( s ) coap_get_non_timeout_random(s)

The NON_TIMEOUT_RANDOM definition for the session (s).

RFC9177 Section 6.2 Default is 2-3 seconds

Definition at line 818 of file coap_session_internal.h.

◆ COAP_NON_TIMEOUT_TICKS

#define COAP_NON_TIMEOUT_TICKS ( s )

Value:

(COAP_NON_TIMEOUT(s).integer_part * COAP_TICKS_PER_SECOND + \

COAP_NON_TIMEOUT(s).fractional_part * COAP_TICKS_PER_SECOND / 1000)

COAP_NON_TIMEOUT

#define COAP_NON_TIMEOUT(s)

Definition coap_session_internal.h:692

Definition at line 693 of file coap_session_internal.h.

◆ COAP_NSTART

#define COAP_NSTART ( s ) ((s)->nstart)

Definition at line 686 of file coap_session_internal.h.

◆ COAP_PROBING_RATE

#define COAP_PROBING_RATE ( s ) ((s)->probing_rate)

Definition at line 688 of file coap_session_internal.h.

◆ COAP_PROCESSING_DELAY

#define COAP_PROCESSING_DELAY ( s )

Value:

(((s)->ack_timeout.integer_part * 1000 + (s)->ack_timeout.fractional_part + \

500) / 1000)

The PROCESSING_DELAY definition for the session (s).

RFC 7252, Section 4.8.2 Calculation of PROCESSING_DELAY PROCESSING_DELAY set to ACK_TIMEOUT

Definition at line 744 of file coap_session_internal.h.

◆ COAP_SESSION_REF

#define COAP_SESSION_REF ( s ) ((s)->ref

Definition at line 680 of file coap_session_internal.h.

Typedef Documentation

◆ coap_ext_token_check_t

typedef enum coap_ext_token_check_t coap_ext_token_check_t

coap_ext_token_check_t values

Enumeration Type Documentation

◆ coap_ext_token_check_t

enum coap_ext_token_check_t

coap_ext_token_check_t values

Enumerator
COAP_EXT_T_NOT_CHECKED	Not checked.
COAP_EXT_T_CHECKED	Token size valid.
COAP_EXT_T_CHECKING	Token size check request sent.

Definition at line 58 of file coap_session_internal.h.

◆ COAP_OSCORE_B_2_STEP

enum COAP_OSCORE_B_2_STEP

Enumerator
COAP_OSCORE_B_2_NONE
COAP_OSCORE_B_2_STEP_1
COAP_OSCORE_B_2_STEP_2
COAP_OSCORE_B_2_STEP_3
COAP_OSCORE_B_2_STEP_4
COAP_OSCORE_B_2_STEP_5

Definition at line 46 of file coap_session_internal.h.

Function Documentation

◆ coap_add_fixed_fixed()

coap_fixed_point_t coap_add_fixed_fixed	(	coap_fixed_point_t	fp1,
		coap_fixed_point_t	fp2
	)

Definition at line 50 of file coap_session.c.

◆ coap_add_fixed_uint()

coap_fixed_point_t coap_add_fixed_uint	(	coap_fixed_point_t	fp1,
		uint32_t	u2
	)

Definition at line 60 of file coap_session.c.

◆ coap_connect_session()

void coap_connect_session	(	coap_session_t *	session,
		coap_tick_t	now
	)

Here is the caller graph for this function:

◆ coap_div_fixed_uint()

coap_fixed_point_t coap_div_fixed_uint	(	coap_fixed_point_t	fp1,
		uint32_t	u2
	)

Definition at line 76 of file coap_session.c.

◆ coap_endpoint_get_session()

coap_session_t * coap_endpoint_get_session	(	coap_endpoint_t *	endpoint,
		const coap_packet_t *	packet,
		coap_tick_t	now
	)

Lookup the server session for the packet received on an endpoint, or create a new one.

Parameters

endpoint	Active endpoint the packet was received on.
packet	Received packet.
now	The current time in ticks.

Returns: The CoAP session or NULL if error.

◆ coap_free_endpoint_lkd()

void coap_free_endpoint_lkd ( coap_endpoint_t * endpoint )

Release an endpoint and all the structures associated with it.

Note: This function must be called in the locked state.

Parameters

endpoint The endpoint to release.

Here is the caller graph for this function:

◆ coap_get_non_timeout_random()

coap_fixed_point_t coap_get_non_timeout_random ( coap_session_t * session )

◆ coap_get_non_timeout_random_ticks()

coap_tick_t coap_get_non_timeout_random_ticks ( coap_session_t * session )

Here is the caller graph for this function:

◆ coap_handle_nack()

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

Definition at line 989 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_multi_fixed_fixed()

coap_fixed_point_t coap_multi_fixed_fixed	(	coap_fixed_point_t	fp1,
		coap_fixed_point_t	fp2
	)

Definition at line 30 of file coap_session.c.

◆ coap_multi_fixed_uint()

coap_fixed_point_t coap_multi_fixed_uint	(	coap_fixed_point_t	fp1,
		uint32_t	u2
	)

Definition at line 40 of file coap_session.c.

◆ coap_new_client_session_lkd()

coap_session_t * coap_new_client_session_lkd	(	coap_context_t *	ctx,
		const coap_address_t *	local_if,
		const coap_address_t *	server,
		coap_proto_t	proto
	)

Creates a new client session to the designated server.

Note: This function must be called in the locked state.

Parameters

ctx	The CoAP context.
local_if	Address of local interface. It is recommended to use NULL to let the operating system choose a suitable local interface. If an address is specified, the port number should be zero, which means that a free port is automatically selected.
server	The server's address. If the port number is zero, the default port for the protocol will be used.
proto	Protocol.

Returns: A new CoAP session or NULL if failed. Call coap_session_release_lkd to free.

◆ coap_new_client_session_pki_lkd()

coap_session_t * coap_new_client_session_pki_lkd	(	coap_context_t *	ctx,
		const coap_address_t *	local_if,
		const coap_address_t *	server,
		coap_proto_t	proto,
		coap_dtls_pki_t *	setup_data
	)

Creates a new client session to the designated server with PKI credentials.

Note: This function must be called in the locked state.

Parameters

ctx	The CoAP context.
local_if	Address of local interface. It is recommended to use NULL to let the operating system choose a suitable local interface. If an address is specified, the port number should be zero, which means that a free port is automatically selected.
server	The server's address. If the port number is zero, the default port for the protocol will be used.
proto	CoAP Protocol.
setup_data	PKI parameters.

Returns: A new CoAP session or NULL if failed. Call coap_session_release_lkd() to free.

◆ coap_new_client_session_psk2_lkd()

coap_session_t * coap_new_client_session_psk2_lkd	(	coap_context_t *	ctx,
		const coap_address_t *	local_if,
		const coap_address_t *	server,
		coap_proto_t	proto,
		coap_dtls_cpsk_t *	setup_data
	)

Creates a new client session to the designated server with PSK credentials.

Note: This function must be called in the locked state.

Parameters

ctx	The CoAP context.
local_if	Address of local interface. It is recommended to use NULL to let the operating system choose a suitable local interface. If an address is specified, the port number should be zero, which means that a free port is automatically selected.
server	The server's address. If the port number is zero, the default port for the protocol will be used.
proto	CoAP Protocol.
setup_data	PSK parameters.

Returns: A new CoAP session or NULL if failed. Call coap_session_release_lkd() to free.

◆ coap_new_client_session_psk_lkd()

coap_session_t * coap_new_client_session_psk_lkd	(	coap_context_t *	ctx,
		const coap_address_t *	local_if,
		const coap_address_t *	server,
		coap_proto_t	proto,
		const char *	identity,
		const uint8_t *	key,
		unsigned	key_len
	)

Creates a new client session to the designated server with PSK credentials.

Note: This function must be called in the locked state.

Deprecated:: Use coap_new_client_session_psk2_lkd() instead.

Parameters

ctx	The CoAP context.
local_if	Address of local interface. It is recommended to use NULL to let the operating system choose a suitable local interface. If an address is specified, the port number should be zero, which means that a free port is automatically selected.
server	The server's address. If the port number is zero, the default port for the protocol will be used.
proto	Protocol.
identity	PSK client identity
key	PSK shared key
key_len	PSK shared key length

Returns: A new CoAP session or NULL if failed. Call coap_session_release_lkd to free.

◆ coap_new_endpoint_lkd()

coap_endpoint_t * coap_new_endpoint_lkd	(	coap_context_t *	context,
		const coap_address_t *	listen_addr,
		coap_proto_t	proto
	)

Create a new endpoint for communicating with peers.

Note: This function must be called in the locked state.

Parameters

context	The coap context that will own the new endpoint,
listen_addr	Address the endpoint will listen for incoming requests on or originate outgoing requests from. Use NULL to specify that no incoming request will be accepted and use a random endpoint.
proto	Protocol used on this endpoint,

Returns: The new endpoint or NULL on failure.

Here is the caller graph for this function:

◆ coap_new_server_session()

coap_session_t * coap_new_server_session	(	coap_context_t *	ctx,
		coap_endpoint_t *	ep,
		void *	extra
	)

Creates a new server session for the specified endpoint.

Parameters

ctx	The CoAP context.
ep	An endpoint where an incoming connection request is pending.
extra	Available for use by any underlying network stack.

Returns: A new CoAP session or NULL if failed. Call coap_session_release_lkd to add to unused queue.

◆ coap_read_session()

void coap_read_session	(	coap_context_t *	ctx,
		coap_session_t *	session,
		coap_tick_t	now
	)

Definition at line 2363 of file coap_net.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_connected()

void coap_session_connected ( coap_session_t * session )

Notify session that it has just connected or reconnected.

Parameters

session The CoAP session.

Definition at line 897 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_delay_pdu()

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

Definition at line 777 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_disconnected_lkd()

void coap_session_disconnected_lkd	(	coap_session_t *	session,
		coap_nack_reason_t	reason
	)

Notify session that it has failed.

This cleans up any outstanding / queued transmissions, observations etc..

Note: This function must be called in the locked state.

Parameters

session	The CoAP session.
reason	The reason why the session was disconnected.

Definition at line 1021 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_establish()

void coap_session_establish ( coap_session_t * session )

Layer function interface for layer below session accept/connect being established.

This function initiates a CSM request for reliable protocols, or coap_session_connect() for un-reliable protocols.

Parameters

session Session that the lower layer accept/connect was done on.

Definition at line 1519 of file coap_session.c.

Here is the call graph for this function:

◆ coap_session_failed()

void coap_session_failed ( coap_session_t * session )

Session has failed due to a socket error.

Parameters

session The session that has failed.

Here is the caller graph for this function:

◆ coap_session_free()

void coap_session_free ( coap_session_t * session )

Definition at line 598 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_max_pdu_rcv_size()

size_t coap_session_max_pdu_rcv_size ( const coap_session_t * session )

Get maximum acceptable receive PDU size.

Parameters

session The CoAP session.

Returns: maximum PDU size, not including header (but including token).

Definition at line 708 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_max_pdu_size_lkd()

size_t coap_session_max_pdu_size_lkd ( const coap_session_t * session )

Get maximum acceptable PDU size.

Note: This function must be called in the locked state.

Parameters

session The CoAP session.

Returns: maximum PDU size, not including header (but including token).

Definition at line 734 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_mfree()

void coap_session_mfree ( coap_session_t * session )

Definition at line 518 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_reconnect()

int coap_session_reconnect ( coap_session_t * session )

Close the current session (if not already closed) and reconnect to server (client session only).

Parameters

session The session to reconnect.

Here is the caller graph for this function:

◆ coap_session_reestablished()

void coap_session_reestablished ( coap_session_t * session )

Session has been re-connected to server.

Parameters

session The session that has been re-established.

Here is the caller graph for this function:

◆ coap_session_reference_lkd()

coap_session_t * coap_session_reference_lkd ( coap_session_t * session )

Increment reference counter on a session.

Note: This function must be called in the locked state.

Parameters

session The CoAP session.

Returns: same as session

Definition at line 356 of file coap_session.c.

Here is the caller graph for this function:

◆ coap_session_refresh_psk_hint()

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

Note: A copy of psk_hint is maintained in the session by libcoap.

Parameters

session	The current coap_session_t object.
psk_hint	If NULL, the Identity Hint will revert to the initial Identity Hint used at session setup.

Returns: 1 if successful, else 0.

Definition at line 1874 of file coap_session.c.

Here is the call graph for this function:

◆ coap_session_refresh_psk_identity()

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

Note: A copy of psk_identity is maintained in the session by libcoap.

Parameters

session	The current coap_session_t object.
psk_identity	If NULL, the pre-shared identity will revert to the initial pre-shared key used as session setup.

Returns: 1 if successful, else 0.

Definition at line 1931 of file coap_session.c.

Here is the call graph for this function:

◆ coap_session_refresh_psk_key()

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

Note: A copy of psk_key is maintained in the session by libcoap.

Parameters

session	The current coap_session_t object.
psk_key	If NULL, the pre-shared key will revert to the initial pre-shared key used at session setup.

Returns: 1 if successful, else 0.

Definition at line 1903 of file coap_session.c.

Here is the call graph for this function:

◆ coap_session_release_lkd()

void coap_session_release_lkd ( coap_session_t * session )

Decrement reference counter on a session.

Note that the session may be deleted as a result and should not be used after this call.

Note: This function must be called in the locked state.

Parameters

session The CoAP session.

Definition at line 376 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_send_csm()

void coap_session_send_csm ( coap_session_t * session )

Notify session transport has just connected and CSM exchange can now start.

Parameters

session The CoAP session.

Definition at line 818 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_send_pdu()

ssize_t coap_session_send_pdu	(	coap_session_t *	session,
		coap_pdu_t *	pdu
	)

Send a pdu according to the session's protocol.

This function returns the number of bytes that have been transmitted, or a value less than zero on error.

Parameters

session	Session to send pdu on.
pdu	The pdu to send.

Returns: The number of bytes written on success, or a value less than zero on error.

Definition at line 1070 of file coap_net.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_send_ping_lkd()

coap_mid_t coap_session_send_ping_lkd ( coap_session_t * session )

Send a ping message for the session.

Parameters

session The CoAP session.

Note: This function must be called in the locked state.

Returns: COAP_INVALID_MID if there is an error

Definition at line 875 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_session_server_keepalive_failed()

void coap_session_server_keepalive_failed ( coap_session_t * session )

Clear down a session following a keepalive failure.

The event handler will get notified of the failure. Note: the session cannot be used after this function is called.

Parameters

session Session to clear down.

Here is the caller graph for this function:

◆ coap_session_set_app_data2_lkd()

void * coap_session_set_app_data2_lkd	(	coap_session_t *	session,
		void *	data,
		coap_app_data_free_callback_t	callback
	)

Stores data with the given session, returning the previously stored value or NULL.

The data callback can be defined if the data is to be released when the session is deleted.

Note: This function must be called in the locked state.

Note: It is the responsibility of the caller to free off (if appropriate) any returned data.

Parameters

session	The CoAP session.
data	The pointer to the data to store or NULL to just clear out the previous data.
callback	The optional release call-back for data on session removal or NULL.

Returns: The previous data (if any) stored in the session.

Definition at line 424 of file coap_session.c.

Here is the caller graph for this function:

◆ coap_session_set_type_client_lkd()

int coap_session_set_type_client_lkd ( coap_session_t * session )

Set the session type to client.

Typically used in a call-home server. The session initially needs to be of type COAP_SESSION_TYPE_SERVER, which is then made COAP_SESSION_TYPE_CLIENT. Note: If this function is successful, the session reference count is incremented and a subsequent coap_session_release() taking the reference count to 0 will cause the (now client) session to be freed off. Note: This function will fail for a DTLS server type session if done before the ClientHello is seen.

Note: This function must be called in the locked state.

Parameters

session The CoAP session.

Returns: 1 if updated, 0 on failure.

Definition at line 2184 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_sub_fixed_uint()

coap_fixed_point_t coap_sub_fixed_uint	(	coap_fixed_point_t	fp1,
		uint32_t	u2
	)

Definition at line 68 of file coap_session.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ COAP_ACK_RANDOM_FACTOR

◆ COAP_ACK_TIMEOUT

◆ COAP_DEFAULT_LEISURE

◆ COAP_DEFAULT_LEISURE_TICKS

◆ COAP_EXCHANGE_LIFETIME

◆ COAP_MAX_PAYLOADS

◆ COAP_MAX_RETRANSMIT

◆ COAP_MAX_RTT

◆ COAP_MAX_TRANSMIT_SPAN

◆ COAP_MAX_TRANSMIT_WAIT

◆ COAP_MAX_TRANSMIT_WAIT_TICKS

◆ COAP_NON_LIFETIME

◆ COAP_NON_MAX_RETRANSMIT

◆ COAP_NON_PARTIAL_TIMEOUT

◆ COAP_NON_PARTIAL_TIMEOUT_TICKS

◆ COAP_NON_PROBING_WAIT

◆ COAP_NON_PROBING_WAIT_BASE

◆ COAP_NON_PROBING_WAIT_TICKS

◆ COAP_NON_RECEIVE_TIMEOUT

◆ COAP_NON_RECEIVE_TIMEOUT_TICKS

◆ COAP_NON_TIMEOUT

◆ COAP_NON_TIMEOUT_RANDOM

◆ COAP_NON_TIMEOUT_TICKS

◆ COAP_NSTART

◆ COAP_PROBING_RATE

◆ COAP_PROCESSING_DELAY

◆ COAP_SESSION_REF

Typedef Documentation

◆ coap_ext_token_check_t

Enumeration Type Documentation

◆ coap_ext_token_check_t

◆ COAP_OSCORE_B_2_STEP

Function Documentation

◆ coap_add_fixed_fixed()

◆ coap_add_fixed_uint()

◆ coap_connect_session()

◆ coap_div_fixed_uint()

◆ coap_endpoint_get_session()

◆ coap_free_endpoint_lkd()

◆ coap_get_non_timeout_random()

◆ coap_get_non_timeout_random_ticks()

◆ coap_handle_nack()

◆ coap_multi_fixed_fixed()

◆ coap_multi_fixed_uint()

◆ coap_new_client_session_lkd()

◆ coap_new_client_session_pki_lkd()

◆ coap_new_client_session_psk2_lkd()

◆ coap_new_client_session_psk_lkd()

◆ coap_new_endpoint_lkd()

◆ coap_new_server_session()

◆ coap_read_session()

◆ coap_session_connected()

◆ coap_session_delay_pdu()

◆ coap_session_disconnected_lkd()

◆ coap_session_establish()

◆ coap_session_failed()

◆ coap_session_free()

◆ coap_session_max_pdu_rcv_size()

◆ coap_session_max_pdu_size_lkd()

◆ coap_session_mfree()

◆ coap_session_reconnect()

◆ coap_session_reestablished()

◆ coap_session_reference_lkd()

◆ coap_session_refresh_psk_hint()

◆ coap_session_refresh_psk_identity()

◆ coap_session_refresh_psk_key()

◆ coap_session_release_lkd()

◆ coap_session_send_csm()

◆ coap_session_send_pdu()

◆ coap_session_send_ping_lkd()

◆ coap_session_server_keepalive_failed()

◆ coap_session_set_app_data2_lkd()

◆ coap_session_set_type_client_lkd()