libcoap  4.3.0rc3
Context Handling (Internal)

CoAP Context Structures, Enums and Functions that are not exposed to applications. More...

Data Structures

struct  coap_queue_t
 Queue entry. More...
 
struct  coap_context_t
 The CoAP stack's global state is stored in a coap_context_t object. More...
 

Functions

int coap_insert_node (coap_queue_t **queue, coap_queue_t *node)
 Adds node to given queue, ordered by variable t in node. More...
 
int coap_delete_node (coap_queue_t *node)
 Destroys specified node. More...
 
void coap_delete_all (coap_queue_t *queue)
 Removes all items from given queue and frees the allocated storage. More...
 
coap_queue_tcoap_new_node (void)
 Creates a new node suitable for adding to the CoAP sendqueue. More...
 
unsigned int coap_adjust_basetime (coap_context_t *ctx, coap_tick_t now)
 Set sendqueue_basetime in the given context object ctx to now. More...
 
coap_queue_tcoap_peek_next (coap_context_t *context)
 Returns the next pdu to send without removing from sendqeue. More...
 
coap_queue_tcoap_pop_next (coap_context_t *context)
 Returns the next pdu to send and removes it from the sendqeue. More...
 
coap_mid_t coap_retransmit (coap_context_t *context, coap_queue_t *node)
 Handles retransmissions of confirmable messages. More...
 
int coap_handle_dgram (coap_context_t *ctx, coap_session_t *session, uint8_t *data, size_t data_len)
 Parses and interprets a CoAP datagram with context ctx. More...
 
int coap_remove_from_queue (coap_queue_t **queue, coap_session_t *session, coap_mid_t id, coap_queue_t **node)
 This function removes the element with given id from the list given list. More...
 
coap_mid_t coap_wait_ack (coap_context_t *context, coap_session_t *session, coap_queue_t *node)
 
void coap_cancel_all_messages (coap_context_t *context, coap_session_t *session, const uint8_t *token, size_t token_length)
 Cancels all outstanding messages for session session that have the specified token. More...
 
void coap_cancel_session_messages (coap_context_t *context, coap_session_t *session, coap_nack_reason_t reason)
 Cancels all outstanding messages for session session. More...
 
void coap_dispatch (coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu)
 Dispatches the PDUs from the receive queue in given context. More...
 
int coap_option_check_critical (coap_context_t *ctx, coap_pdu_t *pdu, coap_opt_filter_t unknown)
 Verifies that pdu contains no unknown critical options. More...
 
coap_pdu_tcoap_wellknown_response (coap_context_t *context, coap_session_t *session, coap_pdu_t *request)
 Creates a new response for given request with the contents of .well-known/core. More...
 
unsigned int coap_calc_timeout (coap_session_t *session, unsigned char r)
 Calculates the initial timeout based on the session CoAP transmission parameters 'ack_timeout', 'ack_random_factor', and COAP_TICKS_PER_SECOND. More...
 

Detailed Description

CoAP Context Structures, Enums and Functions that are not exposed to applications.

Function Documentation

◆ coap_adjust_basetime()

unsigned int coap_adjust_basetime ( coap_context_t ctx,
coap_tick_t  now 
)

Set sendqueue_basetime in the given context object ctx to now.

This function returns the number of elements in the queue head that have timed out.

Definition at line 155 of file net.c.

◆ coap_calc_timeout()

unsigned int coap_calc_timeout ( coap_session_t session,
unsigned char  r 
)

Calculates the initial timeout based on the session CoAP transmission parameters 'ack_timeout', 'ack_random_factor', and COAP_TICKS_PER_SECOND.

The calculation requires 'ack_timeout' and 'ack_random_factor' to be in Qx.FRAC_BITS fixed point notation, whereas the passed parameter r is interpreted as the fractional part of a Q0.MAX_BITS random value.

Parameters
sessionsession timeout is associated with
rrandom value as fractional part of a Q0.MAX_BITS fixed point value
Returns
COAP_TICKS_PER_SECOND * 'ack_timeout' * (1 + ('ack_random_factor' - 1) * r)

Definition at line 945 of file net.c.

+ Here is the caller graph for this function:

◆ coap_cancel_all_messages()

void coap_cancel_all_messages ( coap_context_t context,
coap_session_t session,
const uint8_t *  token,
size_t  token_length 
)

Cancels all outstanding messages for session session that have the specified token.

Parameters
contextThe context in use.
sessionSession of the messages to remove.
tokenMessage token.
token_lengthActual length of token.

Definition at line 2017 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_cancel_session_messages()

void coap_cancel_session_messages ( coap_context_t context,
coap_session_t session,
coap_nack_reason_t  reason 
)

Cancels all outstanding messages for session session.

Parameters
contextThe context in use.
sessionSession of the messages to remove.
reasonThe reasion for the session cancellation

Definition at line 1980 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_delete_all()

void coap_delete_all ( coap_queue_t queue)

Removes all items from given queue and frees the allocated storage.

Internal function.

Parameters
queueThe queue to delete.

Definition at line 249 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_delete_node()

int coap_delete_node ( coap_queue_t node)

Destroys specified node.

Parameters
nodeNode entry to remove.
Returns
1 node deleted from queue, 0 failure.

Definition at line 229 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_dispatch()

void coap_dispatch ( coap_context_t context,
coap_session_t session,
coap_pdu_t pdu 
)

Dispatches the PDUs from the receive queue in given context.

Definition at line 2988 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_handle_dgram()

int coap_handle_dgram ( coap_context_t ctx,
coap_session_t session,
uint8_t *  data,
size_t  data_len 
)

Parses and interprets a CoAP datagram with context ctx.

This function returns 0 if the datagram was handled, or a value less than zero on error.

Parameters
ctxThe current CoAP context.
sessionThe current CoAP session.
dataThe received packet'd data.
data_lenThe received packet'd data length.
Returns
0 if message was handled successfully, or less than zero on error.

Definition at line 1899 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_insert_node()

int coap_insert_node ( coap_queue_t **  queue,
coap_queue_t node 
)

Adds node to given queue, ordered by variable t in node.

Parameters
queueQueue to add to.
nodeNode entry to add to Queue.
Returns
1 added to queue, 0 failure.

Definition at line 192 of file net.c.

+ Here is the caller graph for this function:

◆ coap_new_node()

coap_queue_t* coap_new_node ( void  )

Creates a new node suitable for adding to the CoAP sendqueue.

Returns
New node entry, or NULL if failure.

Definition at line 258 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_option_check_critical()

int coap_option_check_critical ( coap_context_t ctx,
coap_pdu_t pdu,
coap_opt_filter_t  unknown 
)

Verifies that pdu contains no unknown critical options.

Options must be registered at ctx, using the function coap_register_option(). A basic set of options is registered automatically by coap_new_context(). This function returns 1 if pdu is ok, 0 otherwise. The given filter object unknown will be updated with the unknown options. As only COAP_MAX_OPT options can be signalled this way, remaining options must be examined manually.

coap_opt_filter_t f = COAP_OPT_NONE;
if (coap_option_check_critical(ctx, pdu, f) == 0) {
coap_option_iterator_init(pdu, &opt_iter, f);
while (coap_option_next(&opt_iter)) {
if (opt_iter.type & 0x01) {
... handle unknown critical option in opt_iter ...
}
}
}
int coap_option_check_critical(coap_context_t *ctx, coap_pdu_t *pdu, coap_opt_filter_t unknown)
Verifies that pdu contains no unknown critical options.
Definition: net.c:698
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
Definition: option.c:146
coap_opt_iterator_t * coap_option_iterator_init(const coap_pdu_t *pdu, coap_opt_iterator_t *oi, const coap_opt_filter_t *filter)
Initializes the given option iterator oi to point to the beginning of the pdu's option list.
Definition: option.c:110
Iterator to run through PDU options.
Definition: option.h:170
Parameters
ctxThe context where all known options are registered.
pduThe PDU to check.
unknownThe output filter that will be updated to indicate the unknown critical options found in pdu.
Returns
1 if everything was ok, 0 otherwise.

Definition at line 698 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_peek_next()

coap_queue_t* coap_peek_next ( coap_context_t context)

Returns the next pdu to send without removing from sendqeue.

Definition at line 272 of file net.c.

+ Here is the caller graph for this function:

◆ coap_pop_next()

coap_queue_t* coap_pop_next ( coap_context_t context)

Returns the next pdu to send and removes it from the sendqeue.

Definition at line 280 of file net.c.

+ Here is the caller graph for this function:

◆ coap_remove_from_queue()

int coap_remove_from_queue ( coap_queue_t **  queue,
coap_session_t session,
coap_mid_t  id,
coap_queue_t **  node 
)

This function removes the element with given id from the list given list.

If id was found, node is updated to point to the removed element. Note that the storage allocated by node is not released. The caller must do this manually using coap_delete_node(). This function returns 1 if the element with id id was found, 0 otherwise. For a return value of 0, the contents of node is undefined.

Parameters
queueThe queue to search for id.
sessionThe session to look for.
idThe message id to look for.
nodeIf found, node is updated to point to the removed node. You must release the storage pointed to by node manually.
Returns
1 if id was found, 0 otherwise.

Definition at line 1936 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_retransmit()

coap_mid_t coap_retransmit ( coap_context_t context,
coap_queue_t node 
)

Handles retransmissions of confirmable messages.

Parameters
contextThe CoAP context.
nodeThe node to retransmit.
Returns
The message id of the sent message or COAP_INVALID_MID on error.

Definition at line 1338 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_wait_ack()

coap_mid_t coap_wait_ack ( coap_context_t context,
coap_session_t session,
coap_queue_t node 
)

Definition at line 971 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_wellknown_response()

coap_pdu_t* coap_wellknown_response ( coap_context_t context,
coap_session_t session,
coap_pdu_t request 
)

Creates a new response for given request with the contents of .well-known/core.

The result is NULL on error or a newly allocated PDU that must be either sent with coap_sent() or released by coap_delete_pdu().

Parameters
contextThe current coap context to use.
sessionThe CoAP session.
requestThe request for .well-known/core .
Returns
A new 2.05 response for .well-known/core or NULL on error.

Definition at line 2188 of file net.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function: