libcoap 4.3.4-develop-214665a
coap_net_internal.h
Go to the documentation of this file.
1/*
2 * coap_net_internal.h -- CoAP context internal information
3 * exposed to application programming
4 *
5 * Copyright (C) 2010-2024 Olaf Bergmann <bergmann@tzi.org>
6 *
7 * SPDX-License-Identifier: BSD-2-Clause
8 *
9 * This file is part of the CoAP library libcoap. Please see README for terms
10 * of use.
11 */
12
18#ifndef COAP_NET_INTERNAL_H_
19#define COAP_NET_INTERNAL_H_
20
21#include "coap_internal.h"
22#include "coap_subscribe.h"
23
37 unsigned char retransmit_cnt;
39 uint8_t is_mcast;
40 unsigned int timeout;
44};
45
51#if COAP_SERVER_SUPPORT
61#endif /* COAP_SERVER_SUPPORT */
62
63#if COAP_ASYNC_SUPPORT
66 coap_async_t *async_state;
67#endif /* COAP_ASYNC_SUPPORT */
68
74#if COAP_SERVER_SUPPORT
76#endif /* COAP_SERVER_SUPPORT */
77#if COAP_CLIENT_SUPPORT
79#endif /* COAP_CLIENT_SUPPORT */
80
81#ifdef WITH_CONTIKI
82 struct uip_udp_conn *conn;
83 struct ctimer io_timer;
85#endif /* WITH_CONTIKI */
86
87#ifdef WITH_LWIP
89 void *input_arg;
90 uint8_t timer_configured;
93#endif /* WITH_LWIP */
94#ifdef RIOT_VERSION
95 thread_t *selecting_thread;
96#endif /* RIOT_VERSION */
97#if COAP_OSCORE_SUPPORT
98 struct oscore_ctx_t *p_osc_ctx;
99#endif /* COAP_OSCORE_SUPPORT */
100
101#if COAP_CLIENT_SUPPORT
104#endif /* COAP_CLIENT_SUPPORT */
111#if COAP_SERVER_SUPPORT
125#if COAP_WITH_OBSERVE_PERSIST
126 coap_bin_const_t *dyn_resource_save_file;
129 coap_bin_const_t *obs_cnt_save_file;
131 coap_bin_const_t *observe_save_file;
132 coap_pdu_t *unknown_pdu;
133 coap_session_t *unknown_session;
134#endif /* COAP_WITH_OBSERVE_PERSIST */
135#endif /* COAP_SERVER_SUPPORT */
136
142
144
145#if COAP_SERVER_SUPPORT
148#endif /* COAP_SERVER_SUPPORT */
149
150 unsigned int session_timeout;
153 unsigned int max_idle_sessions;
159 unsigned int ping_timeout;
162 uint32_t csm_timeout_ms;
165 uint64_t etag;
167#if COAP_SERVER_SUPPORT
173#endif /* COAP_SERVER_SUPPORT */
174 void *app;
175 uint32_t max_token_size;
176#ifdef COAP_EPOLL_SUPPORT
177 int epfd;
178 int eptimerfd;
179 coap_tick_t next_timeout;
180#else /* ! COAP_EPOLL_SUPPORT */
181#if !defined(RIOT_VERSION)
186 unsigned int num_sockets;
187#endif /* ! RIOT_VERSION */
188#endif /* ! COAP_EPOLL_SUPPORT */
189#if COAP_SERVER_SUPPORT
195#endif /* COAP_SERVER_SUPPORT */
196 uint32_t block_mode;
197#if COAP_THREAD_SAFE
201 coap_lock_t lock;
202#endif /* COAP_THREAD_SAFE */
203};
204
213int coap_insert_node(coap_queue_t **queue, coap_queue_t *node);
214
223
231void coap_delete_all(coap_queue_t *queue);
232
239
245unsigned int coap_adjust_basetime(coap_context_t *ctx, coap_tick_t now);
246
251
256
267
281int coap_handle_dgram(coap_context_t *ctx, coap_session_t *session, uint8_t *data, size_t data_len);
282
300 coap_session_t *session,
301 coap_mid_t id,
302 coap_queue_t **node);
303
305 coap_queue_t *node);
306
316 coap_session_t *session,
317 coap_bin_const_t *token);
318
327 coap_session_t *session,
328 coap_nack_reason_t reason);
329
333void coap_dispatch(coap_context_t *context, coap_session_t *session,
334 coap_pdu_t *pdu);
335
368 coap_pdu_t *pdu,
369 coap_opt_filter_t *unknown);
370
383 coap_session_t *session,
384 coap_pdu_t *request);
385
399unsigned int coap_calc_timeout(coap_session_t *session, unsigned char r);
400
410
427
437
440extern int coap_started;
441
442#endif /* COAP_NET_INTERNAL_H_ */
struct coap_async_t coap_async_t
Async Entry information.
Pulls together all the internal only header files.
coap_nack_reason_t
Definition: coap_io.h:69
coap_mutex_t coap_lock_t
int coap_started
Definition: coap_net.c:4140
Defines the application visible subscribe information.
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:143
void(* coap_resource_release_userdata_handler_t)(void *user_data)
Definition of release resource user_data callback function.
unsigned int coap_adjust_basetime(coap_context_t *ctx, coap_tick_t now)
Set sendqueue_basetime in the given context object ctx to now.
Definition: coap_net.c:130
void coap_delete_all(coap_queue_t *queue)
Removes all items from given queue and frees the allocated storage.
Definition: coap_net.c:224
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.
Definition: coap_net.c:2322
int coap_delete_node(coap_queue_t *node)
Destroys specified node.
Definition: coap_net.c:204
coap_queue_t * coap_peek_next(coap_context_t *context)
Returns the next pdu to send without removing from sendqeue.
Definition: coap_net.c:247
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.
int coap_client_delay_first(coap_session_t *session)
Delay the sending of the first client request until some other negotiation has completed.
Definition: coap_net.c:1016
coap_queue_t * coap_pop_next(coap_context_t *context)
Returns the next pdu to send and removes it from the sendqeue.
Definition: coap_net.c:255
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: coap_net.c:3641
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition: coap_net.c:1461
int coap_insert_node(coap_queue_t **queue, coap_queue_t *node)
Adds node to given queue, ordered by variable t in node.
Definition: coap_net.c:167
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',...
Definition: coap_net.c:913
coap_mid_t coap_retransmit(coap_context_t *context, coap_queue_t *node)
Handles retransmissions of confirmable messages.
Definition: coap_net.c:1690
int coap_check_code_class(coap_session_t *session, coap_pdu_t *pdu)
Check whether the pdu contains a valid code class.
Definition: coap_net.c:1084
int coap_option_check_critical(coap_session_t *session, coap_pdu_t *pdu, coap_opt_filter_t *unknown)
Verifies that pdu contains no unknown critical options.
Definition: coap_net.c:680
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session, coap_queue_t *node)
Definition: coap_net.c:939
coap_queue_t * coap_new_node(void)
Creates a new node suitable for adding to the CoAP sendqueue.
Definition: coap_net.c:233
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.
Definition: coap_net.c:2367
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.
Definition: coap_net.c:2285
void coap_cancel_all_messages(coap_context_t *context, coap_session_t *session, coap_bin_const_t *token)
Cancels all outstanding messages for session session that have the specified token.
Definition: coap_net.c:2410
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.
Definition: coap_net.h:100
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.
Definition: coap_net.h:64
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.
Definition: coap_net.h:89
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.
Definition: coap_net.h:77
int(* coap_event_handler_t)(coap_session_t *session, const coap_event_t event)
Type for event handler functions that can be registered with a CoAP context using the function coap_s...
Definition: coap_event.h:142
int(* coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs)
LwIP callback handler that can be used to wait / timeout for the next input packet.
Definition: coap_net.h:809
int(* coap_dyn_resource_added_t)(coap_session_t *session, coap_str_const_t *resource_name, coap_bin_const_t *raw_packet, void *user_data)
Callback handler definition called when a dynamic resource is getting created, as defined in coap_per...
int(* coap_resource_deleted_t)(coap_context_t *context, coap_str_const_t *resource_name, void *user_data)
Callback handler definition called when resource is removed, as defined in coap_persist_track_funcs()...
int(* coap_observe_added_t)(coap_session_t *session, coap_subscription_t *observe_key, coap_proto_t e_proto, coap_address_t *e_listen_addr, coap_addr_tuple_t *s_addr_info, coap_bin_const_t *raw_packet, coap_bin_const_t *oscore_info, void *user_data)
Callback handler definition called when a new observe has been set up, as defined in coap_persist_tra...
int(* coap_track_observe_value_t)(coap_context_t *context, coap_str_const_t *resource_name, uint32_t observe_num, void *user_data)
Callback handler definition called when an observe unsolicited response is being sent,...
int(* coap_observe_deleted_t)(coap_session_t *session, coap_subscription_t *observe_key, void *user_data)
Callback handler definition called when an observe is being removed, as defined in coap_persist_track...
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: coap_pdu.h:263
CoAP binary data definition with const data.
Definition: coap_str.h:64
The CoAP stack's global state is stored in a coap_context_t object.
coap_tick_t sendqueue_basetime
The time stamp in the first element of the sendqeue is relative to sendqueue_basetime.
coap_pong_handler_t pong_handler
Called when a ping response is received.
uint64_t etag
Next ETag to use.
coap_socket_t * sockets[64]
Track different socket information in coap_io_process_with_fds.
coap_observe_added_t observe_added
Called when there is a new observe subscription request.
void * app
application-specific data
unsigned int num_sockets
Number of sockets being tracked.
coap_session_t * sessions
client sessions
fd_set exceptfds
Used for select call in coap_io_process_with_fds()
coap_nack_handler_t nack_handler
Called when a response issue has occurred.
unsigned int ping_timeout
Minimum inactivity time before sending a ping message.
coap_resource_t * resources
hash table or list of known resources
uint16_t * cache_ignore_options
CoAP options to ignore when creating a cache-key.
coap_dyn_resource_added_t dyn_resource_added
Callback to save dynamic resource when created.
coap_opt_filter_t known_options
coap_resource_release_userdata_handler_t release_userdata
function to release user_data when resource is deleted
coap_ping_handler_t ping_handler
Called when a CoAP ping is received.
uint32_t csm_max_message_size
Value for CSM Max-Message-Size.
void * observe_user_data
App provided data for use in observe_added or observe_deleted.
size_t cache_ignore_count
The number of CoAP options to ignore when creating a cache-key.
unsigned int max_handshake_sessions
Maximum number of simultaneous negotating sessions per endpoint.
coap_queue_t * sendqueue
uint32_t max_token_size
Largest token size supported RFC8974.
coap_response_handler_t response_handler
Called when a response is received.
coap_cache_entry_t * cache
CoAP cache-entry cache.
coap_track_observe_value_t track_observe_value
Callback to save observe value when updated.
uint8_t mcast_per_resource
Mcast controlled on a per resource basis.
uint8_t observe_pending
Observe response pending.
coap_endpoint_t * endpoint
the endpoints used for listening
uint32_t csm_timeout_ms
Timeout for waiting for a CSM from the remote side.
coap_event_handler_t handle_event
Callback function that is used to signal events to the application.
uint32_t observe_save_freq
How frequently to update observe value.
unsigned int session_timeout
Number of seconds of inactivity after which an unused session will be closed.
uint8_t observe_no_clear
Observe 4.04 not to be sent on deleting resource.
uint32_t block_mode
Zero or more COAP_BLOCK_ or'd options.
coap_resource_t * proxy_uri_resource
can be used for handling proxy URI resources
coap_dtls_spsk_t spsk_setup_data
Contains the initial PSK server setup data.
coap_observe_deleted_t observe_deleted
Called when there is a observe subscription de-register request.
coap_resource_t * unknown_resource
can be used for handling unknown resources
coap_resource_deleted_t resource_deleted
Invoked when resource is deleted.
unsigned int max_idle_sessions
Maximum number of simultaneous unused sessions per endpoint.
The structure used for defining the Server PSK setup data to be used.
Definition: coap_dtls.h:467
Abstraction of virtual endpoint that can be attached to coap_context_t.
structure for CoAP PDUs
Queue entry.
coap_session_t * session
the CoAP session
coap_pdu_t * pdu
the CoAP PDU to send
unsigned int timeout
the randomized timeout value
uint8_t is_mcast
Set if this is a queued mcast response.
struct coap_queue_t * next
coap_mid_t id
CoAP message id.
coap_tick_t t
when to send PDU for the next time
unsigned char retransmit_cnt
retransmission counter, will be removed when zero
Abstraction of resource that can be attached to coap_context_t.
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...