libcoap 4.3.5rc1
Loading...
Searching...
No Matches
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#define COAP_BLOCK_SET_MASK (COAP_BLOCK_USE_LIBCOAP | \
35 COAP_BLOCK_SINGLE_BODY | \
36 COAP_BLOCK_TRY_Q_BLOCK | \
37 COAP_BLOCK_USE_M_Q_BLOCK | \
38 COAP_BLOCK_NO_PREEMPTIVE_RTAG | \
39 COAP_BLOCK_STLESS_FETCH | \
40 COAP_BLOCK_STLESS_BLOCK2 | \
41 COAP_BLOCK_NOT_RANDOM_BLOCK1)
42#else /* ! COAP_Q_BLOCK_SUPPORT */
43#define COAP_BLOCK_SET_MASK (COAP_BLOCK_USE_LIBCOAP | \
44 COAP_BLOCK_SINGLE_BODY | \
45 COAP_BLOCK_NO_PREEMPTIVE_RTAG | \
46 COAP_BLOCK_STLESS_FETCH | \
47 COAP_BLOCK_STLESS_BLOCK2 | \
48 COAP_BLOCK_NOT_RANDOM_BLOCK1)
49#endif /* ! COAP_Q_BLOCK_SUPPORT */
50
51#define COAP_BLOCK_MAX_SIZE_MASK 0x7000000 /* (svr)Mask to get the max supported block size */
52#define COAP_BLOCK_MAX_SIZE_SHIFT 24 /* (svr)Mask shift to get the max supported block size */
53#define COAP_BLOCK_MAX_SIZE_GET(a) (((a) & COAP_BLOCK_MAX_SIZE_MASK) >> COAP_BLOCK_MAX_SIZE_SHIFT)
54#define COAP_BLOCK_MAX_SIZE_SET(a) (((a) << COAP_BLOCK_MAX_SIZE_SHIFT) & COAP_BLOCK_MAX_SIZE_MASK)
55
56#if COAP_Q_BLOCK_SUPPORT
57/* Internal use only and are dropped when setting block_mode */
58#define COAP_BLOCK_HAS_Q_BLOCK 0x40000000 /* Set when Q_BLOCK supported */
59#define COAP_BLOCK_PROBE_Q_BLOCK 0x80000000 /* Set when Q_BLOCK probing */
60
61#define set_block_mode_probe_q(block_mode) \
62 do { \
63 block_mode |= COAP_BLOCK_PROBE_Q_BLOCK; \
64 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK | COAP_BLOCK_HAS_Q_BLOCK); \
65 } while (0)
66
67#define set_block_mode_has_q(block_mode) \
68 do { \
69 block_mode |= COAP_BLOCK_HAS_Q_BLOCK; \
70 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK | COAP_BLOCK_PROBE_Q_BLOCK); \
71 } while (0)
72
73#define set_block_mode_drop_q(block_mode) \
74 do { \
75 block_mode &= ~(COAP_BLOCK_TRY_Q_BLOCK |\
76 COAP_BLOCK_PROBE_Q_BLOCK |\
77 COAP_BLOCK_HAS_Q_BLOCK | \
78 COAP_BLOCK_USE_M_Q_BLOCK); \
79 } while (0)
80
81#define COAP_SINGLE_BLOCK_OR_Q (COAP_BLOCK_SINGLE_BODY|COAP_BLOCK_HAS_Q_BLOCK)
82#else /* ! COAP_Q_BLOCK_SUPPORT */
83#define COAP_SINGLE_BLOCK_OR_Q (COAP_BLOCK_SINGLE_BODY)
84#endif /* ! COAP_Q_BLOCK_SUPPORT */
85
90
92 uint32_t begin;
93 uint32_t end;
94};
95
96#define COAP_RBLOCK_CNT 4
100typedef struct coap_rblock_t {
101 uint32_t used;
102 uint32_t retry;
103#if COAP_Q_BLOCK_SUPPORT
104 uint32_t processing_payload_set;
105 uint32_t latest_payload_set;
106#endif /* COAP_Q_BLOCK_SUPPORT */
110
121
136
142 uint8_t blk_size;
143 uint16_t option;
146 const uint8_t *data;
147 size_t length;
148 size_t offset;
149 union {
152 } b;
158#if COAP_Q_BLOCK_SUPPORT
159 coap_tick_t non_timeout_random_ticks;
160#endif /* COAP_Q_BLOCK_SUPPORT */
162 void *app_ptr;
163};
164
165#if COAP_CLIENT_SUPPORT
196#endif /* COAP_CLIENT_SUPPORT */
197
198#if COAP_SERVER_SUPPORT
224#endif /* COAP_SERVER_SUPPORT */
225
226#if COAP_Q_BLOCK_SUPPORT
227typedef enum {
228 COAP_SEND_SKIP_PDU,
229 COAP_SEND_INC_PDU
230} coap_send_pdu_t;
231#endif /* COAP_Q_BLOCK_SUPPORT */
232
233#if COAP_CLIENT_SUPPORT
235 coap_pdu_t *pdu,
236 coap_lg_xmit_t *lg_xmit);
237
239 coap_lg_crcv_t *lg_crcv);
240
242 coap_tick_t now,
243 coap_tick_t *tim_rem);
244
245#if COAP_Q_BLOCK_SUPPORT
246coap_mid_t coap_send_q_block1(coap_session_t *session,
247 coap_block_b_t block,
248 coap_pdu_t *request,
249 coap_send_pdu_t send_request);
250
251coap_tick_t coap_block_check_q_block1_xmit(coap_session_t *session,
252 coap_tick_t now);
253
254coap_mid_t coap_block_test_q_block(coap_session_t *session, coap_pdu_t *actual);
255#endif /* COAP_Q_BLOCK_SUPPORT */
256
257#endif /* COAP_CLIENT_SUPPORT */
258
259#if COAP_Q_BLOCK_SUPPORT
260coap_mid_t coap_send_q_blocks(coap_session_t *session,
261 coap_lg_xmit_t *lg_xmit,
262 coap_block_b_t block,
263 coap_pdu_t *pdu,
264 coap_send_pdu_t send_pdu);
265#endif /* COAP_Q_BLOCK_SUPPORT */
266
267#if COAP_SERVER_SUPPORT
269 coap_lg_srcv_t *lg_srcv);
270
272 coap_tick_t now,
273 coap_tick_t *tim_rem);
274
275#if COAP_Q_BLOCK_SUPPORT
276coap_tick_t coap_block_check_q_block2_xmit(coap_session_t *session,
277 coap_tick_t now);
278
279coap_mid_t coap_send_q_block2(coap_session_t *session,
281 const coap_string_t *query,
282 coap_pdu_code_t request_method,
283 coap_block_b_t block,
284 coap_pdu_t *response,
285 coap_send_pdu_t send_response);
286#endif /* COAP_Q_BLOCK_SUPPORT */
287
289 coap_pdu_t *pdu,
290 coap_pdu_t *response,
292 coap_string_t *query);
293
295 coap_session_t *session,
296 coap_pdu_t *pdu,
297 coap_pdu_t *response,
301 int *added_block,
302 coap_lg_srcv_t **free_lg_srcv);
303
305 const coap_pdu_t *request,
307 const coap_string_t *query);
308
362 coap_session_t *session,
363 const coap_pdu_t *request,
364 coap_pdu_t *response,
365 const coap_string_t *query,
366 uint16_t media_type,
367 int maxage,
368 uint64_t etag,
369 size_t length,
370 const uint8_t *data,
371 coap_release_large_data_t release_func,
372 void *app_ptr);
373
374#endif /* COAP_SERVER_SUPPORT */
375
376#if COAP_CLIENT_SUPPORT
378 coap_pdu_t *rcvd);
379
381 coap_session_t *session,
382 coap_pdu_t *sent,
383 coap_pdu_t *rcvd,
384 coap_recurse_t recursive);
386 coap_pdu_t *pdu,
387 coap_opt_t *echo);
388#endif /* COAP_CLIENT_SUPPORT */
389
391 coap_lg_xmit_t *lg_xmit);
392
394 coap_tick_t now,
395 coap_tick_t *tim_rem);
396
397#if COAP_Q_BLOCK_SUPPORT
398int coap_block_drop_resp_q_block_xmit(coap_session_t *session,
399 coap_lg_xmit_t *lg_xmit);
400
401int coap_block_drop_resp_q_block2_crcv(coap_session_t *session,
402 coap_lg_crcv_t *lg_crcv,
403 coap_pdu_t *sent);
404#endif /* COAP_Q_BLOCK_SUPPORT */
405
417 const coap_pdu_t *request,
418 coap_pdu_t *response,
420 const coap_string_t *query);
421
441 uint32_t block_mode);
442
459int coap_context_set_max_block_size_lkd(coap_context_t *context, size_t max_block_size);
460
461#if COAP_CLIENT_SUPPORT
507 coap_pdu_t *pdu,
508 size_t length,
509 const uint8_t *data,
510 coap_release_large_data_t release_func,
511 void *app_ptr);
512
521#else /* ! COAP_CLIENT_SUPPORT */
522#define coap_check_update_token(a,b)
523#endif /* ! COAP_CLIENT_SUPPORT */
524
527#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.
int coap_add_data_large_response_lkd(coap_resource_t *resource, coap_session_t *session, const coap_pdu_t *request, coap_pdu_t *response, const coap_string_t *query, uint16_t media_type, int maxage, uint64_t etag, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the response pdu that is passed as fourth parameter.
int coap_context_set_max_block_size_lkd(coap_context_t *context, size_t max_block_size)
Set the context level maximum block size that the server supports when sending or receiving packets w...
Definition coap_block.c:412
void coap_block_delete_lg_srcv(coap_session_t *session, coap_lg_srcv_t *lg_srcv)
void coap_context_set_block_mode_lkd(coap_context_t *context, uint32_t block_mode)
Set the context level CoAP block handling bits for handling RFC7959.
Definition coap_block.c:387
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_l...
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)
int coap_add_data_large_request_lkd(coap_session_t *session, coap_pdu_t *pdu, size_t length, const uint8_t *data, coap_release_large_data_t release_func, void *app_ptr)
Associates given data with the pdu that is passed as second parameter.
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)
void coap_block_delete_lg_xmit(coap_session_t *session, coap_lg_xmit_t *lg_xmit)
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)
@ 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:292
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 o_block_option
Block CoAP option used when initiating Observe.
uint16_t content_format
Content format for the set of blocks.
coap_pdu_t pdu
skeletal PDU
uint8_t o_blk_size
Block size used when initiating Observe.
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
Last received mid for this set of packets.
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
uint8_t no_more_seen
Set if block with more not set seen.
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
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_bin_const_t * last_token
< list of received 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.
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