libcoap 4.3.4-develop-214665a
coap_block_internal.h
Go to the documentation of this file.
1/*
2 * coap_block_internal.h -- Structures, Enums & Functions that are not
3 * exposed to application programming
4 *
5 * Copyright (C) 2010-2024 Olaf Bergmann <bergmann@tzi.org>
6 * Copyright (C) 2021-2024 Jon Shallow <supjps-libcoap@jpshallow.com>
7 *
8 * SPDX-License-Identifier: BSD-2-Clause
9 *
10 * This file is part of the CoAP library libcoap. Please see README for terms
11 * of use.
12 */
13
19#ifndef COAP_BLOCK_INTERNAL_H_
20#define COAP_BLOCK_INTERNAL_H_
21
22#include "coap_internal.h"
23#include "coap_pdu_internal.h"
24#include "coap_resource.h"
25
33#if COAP_Q_BLOCK_SUPPORT
34/* Internal use only and are dropped when setting block_mode */
35#define COAP_BLOCK_HAS_Q_BLOCK 0x4000 /* Set when Q_BLOCK supported */
36#define COAP_BLOCK_PROBE_Q_BLOCK 0x8000 /* Set when Q_BLOCK probing */
37
38#define set_block_mode_probe_q(block_mode) \
39 do { \
40 block_mode |= COAP_BLOCK_PROBE_Q_BLOCK; \
41 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK | COAP_BLOCK_HAS_Q_BLOCK); \
42 } while (0)
43
44#define set_block_mode_has_q(block_mode) \
45 do { \
46 block_mode |= COAP_BLOCK_HAS_Q_BLOCK; \
47 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK | COAP_BLOCK_PROBE_Q_BLOCK); \
48 } while (0)
49
50#define set_block_mode_drop_q(block_mode) \
51 do { \
52 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK |\
53 COAP_BLOCK_PROBE_Q_BLOCK |\
54 COAP_BLOCK_HAS_Q_BLOCK | \
55 COAP_BLOCK_USE_M_Q_BLOCK); \
56 } while (0)
57
58#define COAP_SINGLE_BLOCK_OR_Q (COAP_BLOCK_SINGLE_BODY|COAP_BLOCK_HAS_Q_BLOCK)
59#else /* ! COAP_Q_BLOCK_SUPPORT */
60#define COAP_SINGLE_BLOCK_OR_Q (COAP_BLOCK_SINGLE_BODY)
61#endif /* ! COAP_Q_BLOCK_SUPPORT */
62
63typedef enum {
67
69 uint32_t begin;
70 uint32_t end;
71};
72
73#define COAP_RBLOCK_CNT 4
77typedef struct coap_rblock_t {
78 uint32_t used;
79 uint32_t retry;
80#if COAP_Q_BLOCK_SUPPORT
81 uint32_t processing_payload_set;
82 uint32_t latest_payload_set;
83#endif /* COAP_Q_BLOCK_SUPPORT */
87
92typedef struct coap_l_block1_t {
94 uint64_t state_token;
95 size_t bert_size;
96 uint32_t count;
98
103typedef struct coap_l_block2_t {
106 uint64_t etag;
108 uint8_t rtag_set;
109 uint8_t rtag_length;
110 uint8_t rtag[8];
113
119 uint8_t blk_size;
120 uint16_t option;
123 const uint8_t *data;
124 size_t length;
125 size_t offset;
126 union {
129 } b;
135#if COAP_Q_BLOCK_SUPPORT
136 coap_tick_t non_timeout_random_ticks;
137#endif /* COAP_Q_BLOCK_SUPPORT */
139 void *app_ptr;
140};
141
142#if COAP_CLIENT_SUPPORT
148 uint8_t observe[3];
150 uint8_t observe_set;
151 uint8_t szx;
152 uint8_t etag_set;
153 uint8_t etag_length;
154 uint8_t etag[8];
155 uint16_t content_format;
156 uint8_t last_type;
157 uint8_t initial;
158 uint16_t block_option;
159 uint16_t retry_counter;
160 size_t total_len;
166 uint64_t state_token;
170};
171#endif /* COAP_CLIENT_SUPPORT */
172
173#if COAP_SERVER_SUPPORT
179 uint8_t observe[3];
181 uint8_t observe_set;
182 uint8_t rtag_set;
183 uint8_t rtag_length;
184 uint8_t rtag[8];
185 uint16_t content_format;
186 uint8_t last_type;
187 uint8_t szx;
188 size_t total_len;
194#if COAP_Q_BLOCK_SUPPORT
195 coap_bin_const_t *last_token;
196#endif /* COAP_Q_BLOCK_SUPPORT */
199 uint16_t block_option;
200};
201#endif /* COAP_SERVER_SUPPORT */
202
203#if COAP_Q_BLOCK_SUPPORT
204typedef enum {
205 COAP_SEND_SKIP_PDU,
206 COAP_SEND_INC_PDU
207} coap_send_pdu_t;
208#endif /* COAP_Q_BLOCK_SUPPORT */
209
210#if COAP_CLIENT_SUPPORT
212 coap_pdu_t *pdu,
213 coap_lg_xmit_t *lg_xmit);
214
216 coap_lg_crcv_t *lg_crcv);
217
219 coap_tick_t now,
220 coap_tick_t *tim_rem);
221
222#if COAP_Q_BLOCK_SUPPORT
223coap_mid_t coap_send_q_block1(coap_session_t *session,
224 coap_block_b_t block,
225 coap_pdu_t *request,
226 coap_send_pdu_t send_request);
227
228coap_tick_t coap_block_check_q_block1_xmit(coap_session_t *session,
229 coap_tick_t now);
230
231coap_mid_t coap_block_test_q_block(coap_session_t *session, coap_pdu_t *actual);
232#endif /* COAP_Q_BLOCK_SUPPORT */
233
234#endif /* COAP_CLIENT_SUPPORT */
235
236#if COAP_Q_BLOCK_SUPPORT
237coap_mid_t coap_send_q_blocks(coap_session_t *session,
238 coap_lg_xmit_t *lg_xmit,
239 coap_block_b_t block,
240 coap_pdu_t *pdu,
241 coap_send_pdu_t send_pdu);
242#endif /* COAP_Q_BLOCK_SUPPORT */
243
244#if COAP_SERVER_SUPPORT
246 coap_lg_srcv_t *lg_srcv);
247
249 coap_tick_t now,
250 coap_tick_t *tim_rem);
251
252#if COAP_Q_BLOCK_SUPPORT
253coap_tick_t coap_block_check_q_block2_xmit(coap_session_t *session,
254 coap_tick_t now);
255
256coap_mid_t coap_send_q_block2(coap_session_t *session,
258 const coap_string_t *query,
259 coap_pdu_code_t request_method,
260 coap_block_b_t block,
261 coap_pdu_t *response,
262 coap_send_pdu_t send_response);
263#endif /* COAP_Q_BLOCK_SUPPORT */
264
266 coap_pdu_t *pdu,
267 coap_pdu_t *response,
269 coap_string_t *query);
270
272 coap_session_t *session,
273 coap_pdu_t *pdu,
274 coap_pdu_t *response,
278 int *added_block,
279 coap_lg_srcv_t **free_lg_srcv);
280
282 const coap_pdu_t *request,
284 const coap_string_t *query);
285#endif /* COAP_SERVER_SUPPORT */
286
287#if COAP_CLIENT_SUPPORT
289 coap_pdu_t *rcvd);
290
292 coap_session_t *session,
293 coap_pdu_t *sent,
294 coap_pdu_t *rcvd,
295 coap_recurse_t recursive);
297 coap_pdu_t *pdu,
298 coap_opt_t *echo);
299#endif /* COAP_CLIENT_SUPPORT */
300
302 coap_lg_xmit_t *lg_xmit);
303
305 coap_tick_t now,
306 coap_tick_t *tim_rem);
307
308#if COAP_Q_BLOCK_SUPPORT
309int coap_block_drop_resp_q_block_xmit(coap_session_t *session,
310 coap_lg_xmit_t *lg_xmit);
311
312int coap_block_drop_resp_q_block2_crcv(coap_session_t *session,
313 coap_lg_crcv_t *lg_crcv,
314 coap_pdu_t *sent);
315#endif /* COAP_Q_BLOCK_SUPPORT */
316
328 const coap_pdu_t *request,
329 coap_pdu_t *response,
331 const coap_string_t *query);
332
333#if COAP_CLIENT_SUPPORT
342#else /* ! COAP_CLIENT_SUPPORT */
343#define coap_check_update_token(a,b)
344#endif /* ! COAP_CLIENT_SUPPORT */
345
348#endif /* COAP_BLOCK_INTERNAL_H_ */
Pulls together all the internal only header files.
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
Definition: coap_option.h:26
CoAP PDU internal information.
Generic resource handling.
struct coap_rblock_t coap_rblock_t
Structure to keep track of received blocks.
void coap_block_delete_lg_srcv(coap_session_t *session, coap_lg_srcv_t *lg_srcv)
int coap_block_check_lg_crcv_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
int coap_block_check_lg_srcv_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
#define COAP_RBLOCK_CNT
void coap_block_delete_lg_crcv(coap_session_t *session, coap_lg_crcv_t *lg_crcv)
struct coap_l_block1_t coap_l_block1_t
Structure to keep track of block1 specific information (Requests)
int coap_handle_response_get_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd, coap_recurse_t recursive)
void coap_check_code_lg_xmit(const coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_resource_t *resource, const coap_string_t *query)
The function checks that the code in a newly formed lg_xmit created by coap_add_data_large_response()...
int coap_handle_response_send_block(coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd)
coap_mid_t coap_retransmit_oscore_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_opt_t *echo)
void coap_check_update_token(coap_session_t *session, coap_pdu_t *pdu)
The function checks if the token needs to be updated before PDU is presented to the application (only...
struct coap_l_block2_t coap_l_block2_t
Structure to keep track of block2 specific information (Responses)
coap_recurse_t
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
Definition: coap_block.c:2211
int coap_handle_request_put_block(coap_context_t *context, coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *uri_path, coap_opt_t *observe, int *added_block, coap_lg_srcv_t **free_lg_srcv)
coap_lg_xmit_t * coap_find_lg_xmit_response(const coap_session_t *session, const coap_pdu_t *request, const coap_resource_t *resource, const coap_string_t *query)
coap_lg_crcv_t * coap_block_new_lg_crcv(coap_session_t *session, coap_pdu_t *pdu, coap_lg_xmit_t *lg_xmit)
int coap_handle_request_send_block(coap_session_t *session, coap_pdu_t *pdu, coap_pdu_t *response, coap_resource_t *resource, coap_string_t *query)
int coap_block_check_lg_xmit_timeouts(coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
Definition: coap_block.c:1206
@ COAP_RECURSE_OK
@ COAP_RECURSE_NO
void(* coap_release_large_data_t)(coap_session_t *session, void *app_ptr)
Callback handler for de-allocating the data based on app_ptr provided to coap_add_data_large_*() func...
Definition: coap_block.h:312
time_t coap_time_t
CoAP time in seconds since epoch.
Definition: coap_time.h:148
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:143
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_pdu_code_t
Set of codes available for a PDU.
Definition: coap_pdu.h:326
CoAP binary data definition with const data.
Definition: coap_str.h:64
CoAP binary data definition.
Definition: coap_str.h:56
Structure of Block options with BERT support.
Definition: coap_block.h:51
The CoAP stack's global state is stored in a coap_context_t object.
Structure to keep track of block1 specific information (Requests)
uint64_t state_token
state token
size_t bert_size
size of last BERT block
uint32_t count
the number of packets sent for payload
coap_binary_t * app_token
original PDU token
Structure to keep track of block2 specific information (Responses)
coap_pdu_code_t request_method
Method used to request this data.
uint8_t rtag_length
RTag length.
coap_string_t * query
Associated query for the resource.
uint64_t etag
ETag value.
coap_resource_t * resource
associated resource
coap_time_t maxage_expire
When this entry expires.
uint8_t rtag_set
Set if RTag is in receive PDU.
uint8_t rtag[8]
RTag for block checking.
Structure to hold large body (many blocks) client receive information.
uint16_t block_option
Block option in use.
uint8_t etag[8]
ETag for block checking.
uint8_t etag_length
ETag length.
uint8_t last_type
Last request type (CON/NON)
uint8_t observe_length
Length of observe data.
uint8_t observe[3]
Observe data (if observe_set) (only 24 bits)
uint8_t etag_set
Set if ETag is in receive PDU.
coap_rblock_t rec_blocks
struct coap_lg_crcv_t * next
uint8_t initial
If set, has not been used yet.
uint8_t szx
size of individual blocks
uint16_t content_format
Content format for the set of blocks.
coap_pdu_t pdu
skeletal PDU
coap_tick_t last_used
< list of received blocks
coap_bin_const_t ** obs_token
Tokens used in setting up Observe (to handle large FETCH)
uint64_t state_token
state token
coap_binary_t * app_token
app requesting PDU token
uint16_t retry_counter
Retry counter (part of state token)
coap_binary_t * body_data
Used for re-assembling entire body.
size_t obs_token_cnt
number of tokens used to set up Observe
uint8_t observe_set
Set if this is an observe receive PDU.
size_t total_len
Length as indicated by SIZE2 option.
Structure to hold large body (many blocks) server receive information.
uint8_t rtag[8]
RTag for block checking.
coap_mid_t last_mid
< list of received blocks
uint8_t rtag_set
Set if RTag is in receive PDU.
uint16_t block_option
Block option in use.
size_t total_len
Length as indicated by SIZE1 option.
struct coap_lg_srcv_t * next
uint8_t observe_length
Length of observe data.
coap_rblock_t rec_blocks
set to uri_path if unknown resource
coap_binary_t * body_data
Used for re-assembling entire body.
coap_resource_t * resource
associated resource
uint8_t observe_set
Set if this is an observe receive PDU.
uint8_t rtag_length
RTag length.
uint8_t last_type
Last request type (CON/NON)
uint8_t szx
size of individual blocks
size_t amount_so_far
Amount of data seen so far.
coap_tick_t last_used
Last time data sent or 0.
uint8_t observe[3]
Observe data (if set) (only 24 bits)
uint16_t content_format
Content format for the set of blocks.
coap_str_const_t * uri_path
Structure to hold large body (many blocks) transmission information.
coap_tick_t last_all_sent
Last time all data sent or 0.
coap_release_large_data_t release_func
large data de-alloc function
uint8_t blk_size
large block transmission size
coap_tick_t last_sent
Last time any data sent.
union coap_lg_xmit_t::@1 b
const uint8_t * data
large data ptr
int last_block
last acknowledged block number Block1 last transmitted Q-Block2
coap_tick_t last_payload
Last time MAX_PAYLOAD was sent or 0.
size_t offset
large data next offset to transmit
coap_pdu_t pdu
skeletal PDU
size_t length
large data length
coap_l_block1_t b1
coap_l_block2_t b2
uint16_t option
large block transmisson CoAP option
struct coap_lg_xmit_t * next
void * app_ptr
applicaton provided ptr for de-alloc function
coap_tick_t last_obs
Last time used (Observe tracking) or 0.
structure for CoAP PDUs
Structure to keep track of received blocks.
coap_tick_t last_seen
struct coap_lg_range range[COAP_RBLOCK_CNT]
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...
CoAP string data definition with const data.
Definition: coap_str.h:46
CoAP string data definition.
Definition: coap_str.h:38