libcoap  4.2.0
block.h
Go to the documentation of this file.
1 /*
2  * block.h -- block transfer
3  *
4  * Copyright (C) 2010-2012,2014-2015 Olaf Bergmann <bergmann@tzi.org>
5  *
6  * This file is part of the CoAP library libcoap. Please see README for terms
7  * of use.
8  */
9 
10 #ifndef COAP_BLOCK_H_
11 #define COAP_BLOCK_H_
12 
13 #include "encode.h"
14 #include "option.h"
15 #include "pdu.h"
16 
17 struct coap_resource_t;
18 struct coap_session_t;
19 
26 #ifndef COAP_MAX_BLOCK_SZX
27 
30 #define COAP_MAX_BLOCK_SZX 6
31 #endif /* COAP_MAX_BLOCK_SZX */
32 
36 typedef struct {
37  unsigned int num;
38  unsigned int m:1;
39  unsigned int szx:3;
40 } coap_block_t;
41 
47 #define COAP_OPT_BLOCK_LAST(opt) \
48  (coap_opt_length(opt) ? (coap_opt_value(opt) + (coap_opt_length(opt)-1)) : 0)
49 
51 #define COAP_OPT_BLOCK_MORE(opt) \
52  (coap_opt_length(opt) ? (*COAP_OPT_BLOCK_LAST(opt) & 0x08) : 0)
53 
55 #define COAP_OPT_BLOCK_SZX(opt) \
56  (coap_opt_length(opt) ? (*COAP_OPT_BLOCK_LAST(opt) & 0x07) : 0)
57 
61 unsigned int coap_opt_block_num(const coap_opt_t *block_opt);
62 
68 coap_more_blocks(size_t data_len, unsigned int num, uint16_t szx) {
69  return ((num+1) << (szx + 4)) < data_len;
70 }
71 
72 #if 0
73 
75 coap_opt_block_set_m(coap_opt_t *block_opt, int m) {
76  if (m)
77  *(coap_opt_value(block_opt) + (coap_opt_length(block_opt) - 1)) |= 0x08;
78  else
79  *(coap_opt_value(block_opt) + (coap_opt_length(block_opt) - 1)) &= ~0x08;
80 }
81 #endif
82 
96 int coap_get_block(coap_pdu_t *pdu, uint16_t type, coap_block_t *block);
97 
119  uint16_t type,
120  coap_pdu_t *pdu,
121  size_t data_length);
122 
135 int coap_add_block(coap_pdu_t *pdu,
136  unsigned int len,
137  const uint8_t *data,
138  unsigned int block_num,
139  unsigned char block_szx);
140 
160 void
162  struct coap_session_t *session,
163  coap_pdu_t *request,
164  coap_pdu_t *response,
165  const coap_binary_t *token,
166  uint16_t media_type,
167  int maxage,
168  size_t length,
169  const uint8_t* data);
170 
173 #endif /* COAP_BLOCK_H_ */
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
Definition: option.h:25
unsigned int coap_opt_block_num(const coap_opt_t *block_opt)
Returns the value of field num in the given block option block_opt.
Definition: block.c:27
int coap_add_block(coap_pdu_t *pdu, unsigned int len, const uint8_t *data, unsigned int block_num, unsigned char block_szx)
Adds the block_num block of size 1 << (block_szx + 4) from source data to pdu.
Definition: block.c:135
Helpers for handling options in CoAP PDUs.
COAP_STATIC_INLINE int coap_more_blocks(size_t data_len, unsigned int num, uint16_t szx)
Checks if more than num blocks are required to deliver data_len bytes of data for a block size of 1 <...
Definition: block.h:68
void coap_add_data_blocked_response(struct coap_resource_t *resource, struct coap_session_t *session, coap_pdu_t *request, coap_pdu_t *response, const coap_binary_t *token, uint16_t media_type, int maxage, size_t length, const uint8_t *data)
Adds the appropriate part of data to the response pdu.
Definition: block.c:152
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Definition: pdu.h:287
uint16_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
Definition: option.c:249
Coap binary data definition.
Definition: str.h:43
coap_session_type_t type
client or server side socket
Definition: coap_session.h:59
int coap_write_block_opt(coap_block_t *block, uint16_t type, coap_pdu_t *pdu, size_t data_length)
Writes a block option of type type to message pdu.
Definition: block.c:74
#define COAP_STATIC_INLINE
Definition: libcoap.h:38
Pre-defined constants that reflect defaults for CoAP.
Structure of Block options.
Definition: block.h:36
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
Definition: option.c:286
int coap_get_block(coap_pdu_t *pdu, uint16_t type, coap_block_t *block)
Initializes block from pdu.
Definition: block.c:46
unsigned char uint8_t
Definition: uthash.h:79
unsigned int m
1 if more blocks follow, 0 otherwise
Definition: block.h:38
unsigned int szx
block size
Definition: block.h:39
unsigned int num
block number
Definition: block.h:37