coap_block_internal.h File Reference

CoAP block internal information. More...

#include "coap_internal.h"
#include "coap_pdu_internal.h"
#include "coap_resource.h"

Include dependency graph for coap_block_internal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	coap_lg_range
struct	coap_rblock_t
	Structure to keep track of received blocks. More...
struct	coap_l_block1_t
	Structure to keep track of block1 specific information (Requests) More...
struct	coap_l_block2_t
	Structure to keep track of block2 specific information (Responses) More...
struct	coap_lg_xmit_t
	Structure to hold large body (many blocks) transmission information. More...
struct	coap_lg_crcv_t
	Structure to hold large body (many blocks) client receive information. More...
struct	coap_lg_srcv_t
	Structure to hold large body (many blocks) server receive information. More...

Macros
#define	STATE_MAX_BLK_CNT_BITS   20
#define	STATE_TOKEN_BASE(t)   ((t) & (0xffffffffffffffffULL >> STATE_MAX_BLK_CNT_BITS))
#define	STATE_TOKEN_RETRY(t)   ((uint64_t)(t) >> (64 - STATE_MAX_BLK_CNT_BITS))
#define	STATE_TOKEN_FULL(t, r)   (STATE_TOKEN_BASE(t) + ((uint64_t)(r) << (64 - STATE_MAX_BLK_CNT_BITS)))
#define	COAP_BLOCK_SET_MASK
#define	COAP_BLOCK_MAX_SIZE_MASK   0x7000000 /* (svr)Mask to get the max supported block size */
#define	COAP_BLOCK_MAX_SIZE_SHIFT   24 /* (svr)Mask shift to get the max supported block size */
#define	COAP_BLOCK_MAX_SIZE_GET(a)   (((a) & COAP_BLOCK_MAX_SIZE_MASK) >> COAP_BLOCK_MAX_SIZE_SHIFT)
#define	COAP_BLOCK_MAX_SIZE_SET(a)   (((a) << COAP_BLOCK_MAX_SIZE_SHIFT) & COAP_BLOCK_MAX_SIZE_MASK)
#define	COAP_SINGLE_BLOCK_OR_Q   (COAP_BLOCK_SINGLE_BODY)
#define	COAP_RBLOCK_CNT   4

Typedefs
typedef struct coap_rblock_t	coap_rblock_t
	Structure to keep track of received blocks. More...
typedef struct coap_l_block1_t	coap_l_block1_t
	Structure to keep track of block1 specific information (Requests) More...
typedef struct coap_l_block2_t	coap_l_block2_t
	Structure to keep track of block2 specific information (Responses) More...

Enumerations
enum	coap_recurse_t { COAP_RECURSE_OK , COAP_RECURSE_NO }

Functions
coap_lg_crcv_t *	coap_block_new_lg_crcv (coap_session_t *session, coap_pdu_t *pdu, coap_lg_xmit_t *lg_xmit)
void	coap_block_delete_lg_crcv (coap_session_t *session, coap_lg_crcv_t *lg_crcv)
int	coap_block_check_lg_crcv_timeouts (coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
void	coap_block_delete_lg_srcv (coap_session_t *session, coap_lg_srcv_t *lg_srcv)
int	coap_block_check_lg_srcv_timeouts (coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
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_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)
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. More...
int	coap_handle_response_send_block (coap_session_t *session, coap_pdu_t *sent, coap_pdu_t *rcvd)
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)
coap_mid_t	coap_retransmit_oscore_pdu (coap_session_t *session, coap_pdu_t *pdu, coap_opt_t *echo)
void	coap_block_delete_lg_xmit (coap_session_t *session, coap_lg_xmit_t *lg_xmit)
int	coap_block_check_lg_xmit_timeouts (coap_session_t *session, coap_tick_t now, coap_tick_t *tim_rem)
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_lkd() is updated. More...
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. More...
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 with Block1 or Block2 options. More...
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. More...
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 relevant to clients). More...

Detailed Description

CoAP block internal information.

Definition in file coap_block_internal.h.