libcoap  4.3.0rc3
option.h
Go to the documentation of this file.
1 /*
2  * option.h -- helpers for handling options in CoAP PDUs
3  *
4  * Copyright (C) 2010-2013 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 
15 #ifndef COAP_OPTION_H_
16 #define COAP_OPTION_H_
17 
18 #include "bits.h"
19 
20 typedef uint16_t coap_option_num_t;
21 
26 typedef uint8_t coap_opt_t;
27 #define PCHAR(p) ((coap_opt_t *)(p))
28 
32 typedef struct {
33  uint16_t delta;
34  size_t length;
35  const uint8_t *value;
37 
50 size_t coap_opt_parse(const coap_opt_t *opt,
51  size_t length,
52  coap_option_t *result);
53 
63 size_t coap_opt_size(const coap_opt_t *opt);
64 
77 #define COAP_OPT_FILTER_SHORT 6
78 
85 #define COAP_OPT_FILTER_LONG 2
86 
87 /* Ensure that COAP_OPT_FILTER_SHORT and COAP_OPT_FILTER_LONG are set
88  * correctly. */
89 #if (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16)
90 #error COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG must be less or equal 16
91 #endif /* (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16) */
92 
93 /*
94  * mask contains a bit vector that indicates which fields in the long_opts[]
95  * and subsequent short_opts[] are used. The first COAP_OPT_FILTER_LONG bits
96  * correspond to the long option types that are stored in long_opts[]
97  * elements. The next COAP_OPT_FILTER_SHORT bits correspond to the short
98  * option types that are stored in short_opts[].
99  */
100 typedef struct coap_opt_filter_t {
101  uint16_t mask;
105 
107 #define COAP_OPT_ALL NULL
108 
114 void
116 
128 
140  coap_option_num_t number);
141 
153 
170 typedef struct {
171  size_t length;
173  unsigned int bad:1;
174  unsigned int filtered:1;
178 
197  const coap_opt_filter_t *filter);
198 
216 
231  coap_option_num_t number,
232  coap_opt_iterator_t *oi);
233 
248 size_t coap_opt_setheader(coap_opt_t *opt,
249  size_t maxlen,
250  uint16_t delta,
251  size_t length);
252 
262 size_t coap_opt_encode_size(uint16_t delta, size_t length);
263 
279 size_t coap_opt_encode(coap_opt_t *opt,
280  size_t n,
281  uint16_t delta,
282  const uint8_t *val,
283  size_t length);
284 
298 uint32_t coap_opt_length(const coap_opt_t *opt);
299 
309 const uint8_t *coap_opt_value(const coap_opt_t *opt);
310 
327 typedef struct coap_optlist_t {
329  uint16_t number;
330  size_t length;
331  uint8_t *data;
333 
350  size_t length,
351  const uint8_t *data);
352 
362 int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t** optlist_chain);
363 
375 int coap_insert_optlist(coap_optlist_t **optlist_chain,
376  coap_optlist_t *optlist);
377 
384 void coap_delete_optlist(coap_optlist_t *optlist_chain);
385 
401 coap_option_setb(coap_opt_filter_t *filter, uint16_t type) {
402  return coap_option_filter_set(filter, type) ? 1 : -1;
403 }
404 
418 coap_option_clrb(coap_opt_filter_t *filter, uint16_t type) {
419  return coap_option_filter_unset(filter, type) ? 1 : -1;
420 }
421 
435 coap_option_getb(coap_opt_filter_t *filter, uint16_t type) {
436  return coap_option_filter_get(filter, type);
437 }
438 
439 #endif /* COAP_OPTION_H_ */
Bit vector manipulation.
coap_optlist_t * coap_new_optlist(uint16_t number, size_t length, const uint8_t *data)
Create a new optlist entry.
Definition: option.c:506
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
Definition: option.c:146
size_t coap_opt_encode(coap_opt_t *opt, size_t n, uint16_t delta, const uint8_t *val, size_t length)
Encodes option with given delta into opt.
Definition: option.c:369
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
Definition: option.c:209
void coap_delete_optlist(coap_optlist_t *optlist_chain)
Removes all entries from the optlist_chain, freeing off their memory usage.
Definition: option.c:584
size_t coap_opt_encode_size(uint16_t delta, size_t length)
Compute storage bytes needed for an option with given delta and length.
Definition: option.c:348
coap_opt_t * coap_check_option(const coap_pdu_t *pdu, coap_option_num_t number, coap_opt_iterator_t *oi)
Retrieves the first option of number number from pdu.
Definition: option.c:196
#define COAP_OPT_FILTER_SHORT
The number of option types below 256 that can be stored in an option filter.
Definition: option.h:77
struct coap_opt_filter_t coap_opt_filter_t
int coap_option_filter_unset(coap_opt_filter_t *filter, coap_option_num_t number)
Clears the corresponding entry for number in filter.
Definition: option.c:496
int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t **optlist_chain)
The current optlist of optlist_chain is first sorted (as per RFC7272 ordering requirements) and then ...
Definition: option.c:547
#define COAP_OPT_FILTER_LONG
The number of option types above 255 that can be stored in an option filter.
Definition: option.h:85
struct coap_optlist_t coap_optlist_t
Representation of chained list of CoAP options to install.
void coap_option_filter_clear(coap_opt_filter_t *filter)
Clears filter filter.
Definition: option.c:486
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
Definition: option.c:246
coap_opt_iterator_t * coap_option_iterator_init(const coap_pdu_t *pdu, coap_opt_iterator_t *oi, const coap_opt_filter_t *filter)
Initializes the given option iterator oi to point to the beginning of the pdu's option list.
Definition: option.c:110
int coap_insert_optlist(coap_optlist_t **optlist_chain, coap_optlist_t *optlist)
Adds optlist to the given optlist_chain.
Definition: option.c:563
int coap_option_filter_get(coap_opt_filter_t *filter, coap_option_num_t number)
Checks if number is contained in filter.
Definition: option.c:501
int coap_option_filter_set(coap_opt_filter_t *filter, coap_option_num_t number)
Sets the corresponding entry for number in filter.
Definition: option.c:491
size_t coap_opt_setheader(coap_opt_t *opt, size_t maxlen, uint16_t delta, size_t length)
Encodes the given delta and length values into opt.
Definition: option.c:289
#define COAP_DEPRECATED
Definition: libcoap.h:46
#define COAP_STATIC_INLINE
Definition: libcoap.h:38
const uint32_t n
Definition: murmur3.c:56
size_t coap_opt_parse(const coap_opt_t *opt, size_t length, coap_option_t *result)
Parses the option pointed to by opt into result.
Definition: option.c:35
size_t coap_opt_size(const coap_opt_t *opt)
Returns the size of the given option, taking into account a possible option jump.
Definition: option.c:281
uint16_t coap_option_num_t
Definition: option.h:20
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:26
COAP_STATIC_INLINE COAP_DEPRECATED int coap_option_clrb(coap_opt_filter_t *filter, uint16_t type)
Clears the corresponding bit for type in filter.
Definition: option.h:418
COAP_STATIC_INLINE COAP_DEPRECATED int coap_option_getb(coap_opt_filter_t *filter, uint16_t type)
Gets the corresponding bit for type in filter.
Definition: option.h:435
COAP_STATIC_INLINE COAP_DEPRECATED int coap_option_setb(coap_opt_filter_t *filter, uint16_t type)
Sets the corresponding bit for type in filter.
Definition: option.h:401
uint16_t mask
Definition: option.h:101
uint8_t short_opts[COAP_OPT_FILTER_SHORT]
Definition: option.h:103
uint16_t long_opts[COAP_OPT_FILTER_LONG]
Definition: option.h:102
Iterator to run through PDU options.
Definition: option.h:170
coap_opt_t * next_option
pointer to the unparsed next option
Definition: option.h:175
coap_opt_filter_t filter
option filter
Definition: option.h:176
unsigned int bad
iterator object is ok if not set
Definition: option.h:173
size_t length
remaining length of PDU
Definition: option.h:171
unsigned int filtered
denotes whether or not filter is used
Definition: option.h:174
coap_option_num_t number
decoded option number
Definition: option.h:172
Representation of CoAP options.
Definition: option.h:32
const uint8_t * value
Definition: option.h:35
uint16_t delta
Definition: option.h:33
size_t length
Definition: option.h:34
Representation of chained list of CoAP options to install.
Definition: option.h:327
uint16_t number
the option number (no delta coding)
Definition: option.h:329
size_t length
the option value length
Definition: option.h:330
uint8_t * data
the option data
Definition: option.h:331
struct coap_optlist_t * next
next entry in the optlist chain
Definition: option.h:328
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...