libcoap  4.3.0beta
coap_context_t Struct Reference

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

#include <net.h>

+ Collaboration diagram for coap_context_t:

Data Fields

coap_opt_filter_t known_options
 
struct coap_resource_tresources
 hash table or list of known resources More...
 
struct coap_resource_tunknown_resource
 can be used for handling unknown resources More...
 
struct coap_resource_tproxy_uri_resource
 can be used for handling proxy URI resources More...
 
struct coap_async_state_tasync_state
 list of asynchronous transactions More...
 
coap_tick_t sendqueue_basetime
 The time stamp in the first element of the sendqeue is relative to sendqueue_basetime. More...
 
coap_queue_tsendqueue
 
coap_endpoint_tendpoint
 the endpoints used for listening
More...
 
coap_session_tsessions
 client sessions More...
 
coap_response_handler_t response_handler
 
coap_nack_handler_t nack_handler
 
coap_ping_handler_t ping_handler
 
coap_pong_handler_t pong_handler
 
coap_event_handler_t handle_event
 Callback function that is used to signal events to the application. More...
 
ssize_t(* network_send )(coap_socket_t *sock, const coap_session_t *session, const uint8_t *data, size_t datalen)
 
ssize_t(* network_read )(coap_socket_t *sock, struct coap_packet_t *packet)
 
size_t(* get_client_psk )(const coap_session_t *session, const uint8_t *hint, size_t hint_len, uint8_t *identity, size_t *identity_len, size_t max_identity_len, uint8_t *psk, size_t max_psk_len)
 
size_t(* get_server_psk )(const coap_session_t *session, const uint8_t *identity, size_t identity_len, uint8_t *psk, size_t max_psk_len)
 
size_t(* get_server_hint )(const coap_session_t *session, uint8_t *hint, size_t max_hint_len)
 
void * dtls_context
 
coap_dtls_spsk_t spsk_setup_data
 Contains the initial PSK server setup data. More...
 
unsigned int session_timeout
 Number of seconds of inactivity after which an unused session will be closed. More...
 
unsigned int max_idle_sessions
 Maximum number of simultaneous unused sessions per endpoint. More...
 
unsigned int max_handshake_sessions
 Maximum number of simultaneous negotating sessions per endpoint. More...
 
unsigned int ping_timeout
 Minimum inactivity time before sending a ping message. More...
 
unsigned int csm_timeout
 Timeout for waiting for a CSM from the remote side. More...
 
int observe_pending
 Observe response pending. More...
 
coap_cache_entry_tcache
 CoAP cache-entry cache. More...
 
uint16_t * cache_ignore_options
 CoAP options to ignore when creating a cache-key. More...
 
size_t cache_ignore_count
 The number of CoAP options to ignore when creating a cache-key. More...
 
void * app
 application-specific data More...
 

Detailed Description

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

Definition at line 141 of file net.h.

Field Documentation

◆ app

void* coap_context_t::app

application-specific data

Definition at line 209 of file net.h.

◆ async_state

struct coap_async_state_t* coap_context_t::async_state

list of asynchronous transactions

Definition at line 153 of file net.h.

◆ cache

coap_cache_entry_t* coap_context_t::cache

CoAP cache-entry cache.

Definition at line 206 of file net.h.

◆ cache_ignore_count

size_t coap_context_t::cache_ignore_count

The number of CoAP options to ignore when creating a cache-key.

Definition at line 208 of file net.h.

◆ cache_ignore_options

uint16_t* coap_context_t::cache_ignore_options

CoAP options to ignore when creating a cache-key.

Definition at line 207 of file net.h.

◆ csm_timeout

unsigned int coap_context_t::csm_timeout

Timeout for waiting for a CSM from the remote side.

0 means disabled.

Definition at line 203 of file net.h.

◆ dtls_context

void* coap_context_t::dtls_context

Definition at line 195 of file net.h.

◆ endpoint

coap_endpoint_t* coap_context_t::endpoint

the endpoints used for listening

Definition at line 161 of file net.h.

◆ get_client_psk

size_t(* coap_context_t::get_client_psk) (const coap_session_t *session, const uint8_t *hint, size_t hint_len, uint8_t *identity, size_t *identity_len, size_t max_identity_len, uint8_t *psk, size_t max_psk_len)

Definition at line 191 of file net.h.

◆ get_server_hint

size_t(* coap_context_t::get_server_hint) (const coap_session_t *session, uint8_t *hint, size_t max_hint_len)

Definition at line 193 of file net.h.

◆ get_server_psk

size_t(* coap_context_t::get_server_psk) (const coap_session_t *session, const uint8_t *identity, size_t identity_len, uint8_t *psk, size_t max_psk_len)

Definition at line 192 of file net.h.

◆ handle_event

coap_event_handler_t coap_context_t::handle_event

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

This field is set by coap_set_event_handler().

Definition at line 185 of file net.h.

◆ known_options

coap_opt_filter_t coap_context_t::known_options

Definition at line 142 of file net.h.

◆ max_handshake_sessions

unsigned int coap_context_t::max_handshake_sessions

Maximum number of simultaneous negotating sessions per endpoint.

0 means use default.

Definition at line 201 of file net.h.

◆ max_idle_sessions

unsigned int coap_context_t::max_idle_sessions

Maximum number of simultaneous unused sessions per endpoint.

0 means no maximum.

Definition at line 200 of file net.h.

◆ nack_handler

coap_nack_handler_t coap_context_t::nack_handler

Definition at line 177 of file net.h.

◆ network_read

ssize_t(* coap_context_t::network_read) (coap_socket_t *sock, struct coap_packet_t *packet)

Definition at line 189 of file net.h.

◆ network_send

ssize_t(* coap_context_t::network_send) (coap_socket_t *sock, const coap_session_t *session, const uint8_t *data, size_t datalen)

Definition at line 187 of file net.h.

◆ observe_pending

int coap_context_t::observe_pending

Observe response pending.

Definition at line 204 of file net.h.

◆ ping_handler

coap_ping_handler_t coap_context_t::ping_handler

Definition at line 178 of file net.h.

◆ ping_timeout

unsigned int coap_context_t::ping_timeout

Minimum inactivity time before sending a ping message.

0 means disabled.

Definition at line 202 of file net.h.

◆ pong_handler

coap_pong_handler_t coap_context_t::pong_handler

Definition at line 179 of file net.h.

◆ proxy_uri_resource

struct coap_resource_t* coap_context_t::proxy_uri_resource

can be used for handling proxy URI resources

Definition at line 147 of file net.h.

◆ resources

struct coap_resource_t* coap_context_t::resources

hash table or list of known resources

Definition at line 143 of file net.h.

◆ response_handler

coap_response_handler_t coap_context_t::response_handler

Definition at line 176 of file net.h.

◆ sendqueue

coap_queue_t* coap_context_t::sendqueue

Definition at line 160 of file net.h.

◆ sendqueue_basetime

coap_tick_t coap_context_t::sendqueue_basetime

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

Definition at line 159 of file net.h.

◆ session_timeout

unsigned int coap_context_t::session_timeout

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

0 means use default.

Definition at line 199 of file net.h.

◆ sessions

coap_session_t* coap_context_t::sessions

client sessions

Definition at line 162 of file net.h.

◆ spsk_setup_data

coap_dtls_spsk_t coap_context_t::spsk_setup_data

Contains the initial PSK server setup data.

Definition at line 197 of file net.h.

◆ unknown_resource

struct coap_resource_t* coap_context_t::unknown_resource

can be used for handling unknown resources

Definition at line 145 of file net.h.


The documentation for this struct was generated from the following file: