libcoap  4.3.1
coap_option.h
Go to the documentation of this file.
1 /*
2  * coap_option.h -- helpers for handling options in CoAP PDUs
3  *
4  * Copyright (C) 2010-2013,2022 Olaf Bergmann <bergmann@tzi.org>
5  *
6  * SPDX-License-Identifier: BSD-2-Clause
7  *
8  * This file is part of the CoAP library libcoap. Please see README for terms
9  * of use.
10  */
11 
17 #ifndef COAP_OPTION_H_
18 #define COAP_OPTION_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 
78 #define COAP_OPT_FILTER_SHORT 6
79 
86 #define COAP_OPT_FILTER_LONG 2
87 
88 /* Ensure that COAP_OPT_FILTER_SHORT and COAP_OPT_FILTER_LONG are set
89  * correctly. */
90 #if (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16)
91 #error COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG must be less or equal 16
92 #endif /* (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16) */
93 
94 /*
95  * mask contains a bit vector that indicates which fields in the long_opts[]
96  * and subsequent short_opts[] are used. The first COAP_OPT_FILTER_LONG bits
97  * correspond to the long option types that are stored in long_opts[]
98  * elements. The next COAP_OPT_FILTER_SHORT bits correspond to the short
99  * option types that are stored in short_opts[].
100  */
101 typedef struct coap_opt_filter_t {
102  uint16_t mask;
106 
108 #define COAP_OPT_ALL NULL
109 
115 void
117 
129 
141  coap_option_num_t number);
142 
154 
171 typedef struct {
172  size_t length;
174  unsigned int bad:1;
175  unsigned int filtered:1;
179 
198  const coap_opt_filter_t *filter);
199 
217 
232  coap_option_num_t number,
233  coap_opt_iterator_t *oi);
234 
249 size_t coap_opt_setheader(coap_opt_t *opt,
250  size_t maxlen,
251  uint16_t delta,
252  size_t length);
253 
263 size_t coap_opt_encode_size(uint16_t delta, size_t length);
264 
280 size_t coap_opt_encode(coap_opt_t *opt,
281  size_t n,
282  uint16_t delta,
283  const uint8_t *val,
284  size_t length);
285 
299 uint32_t coap_opt_length(const coap_opt_t *opt);
300 
310 const uint8_t *coap_opt_value(const coap_opt_t *opt);
311 
328 typedef struct coap_optlist_t {
330  uint16_t number;
331  size_t length;
332  uint8_t *data;
334 
351  size_t length,
352  const uint8_t *data);
353 
363 int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t** optlist_chain);
364 
376 int coap_insert_optlist(coap_optlist_t **optlist_chain,
377  coap_optlist_t *optlist);
378 
385 void coap_delete_optlist(coap_optlist_t *optlist_chain);
386 
402 coap_option_setb(coap_opt_filter_t *filter, uint16_t type) {
403  return coap_option_filter_set(filter, type) ? 1 : -1;
404 }
405 
419 coap_option_clrb(coap_opt_filter_t *filter, uint16_t type) {
420  return coap_option_filter_unset(filter, type) ? 1 : -1;
421 }
422 
436 coap_option_getb(coap_opt_filter_t *filter, uint16_t type) {
437  return coap_option_filter_get(filter, type);
438 }
439 
440 #endif /* COAP_OPTION_H_ */
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: coap_option.c:41
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: coap_option.c:287
uint16_t coap_option_num_t
Definition: coap_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: coap_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: coap_option.h:419
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: coap_option.h:436
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: coap_option.h:402
coap_optlist_t * coap_new_optlist(uint16_t number, size_t length, const uint8_t *data)
Create a new optlist entry.
Definition: coap_option.c:512
coap_opt_t * coap_option_next(coap_opt_iterator_t *oi)
Updates the iterator oi to point to the next option.
Definition: coap_option.c:152
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: coap_option.c:375
uint32_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
Definition: coap_option.c:215
void coap_delete_optlist(coap_optlist_t *optlist_chain)
Removes all entries from the optlist_chain, freeing off their memory usage.
Definition: coap_option.c:595
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: coap_option.c:354
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: coap_option.c:202
#define COAP_OPT_FILTER_SHORT
The number of option types below 256 that can be stored in an option filter.
Definition: coap_option.h:78
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: coap_option.c:502
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: coap_option.c:553
#define COAP_OPT_FILTER_LONG
The number of option types above 255 that can be stored in an option filter.
Definition: coap_option.h:86
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: coap_option.c:492
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
Definition: coap_option.c:252
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: coap_option.c:116
int coap_insert_optlist(coap_optlist_t **optlist_chain, coap_optlist_t *optlist)
Adds optlist to the given optlist_chain.
Definition: coap_option.c:574
int coap_option_filter_get(coap_opt_filter_t *filter, coap_option_num_t number)
Checks if number is contained in filter.
Definition: coap_option.c:507
int coap_option_filter_set(coap_opt_filter_t *filter, coap_option_num_t number)
Sets the corresponding entry for number in filter.
Definition: coap_option.c:497
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: coap_option.c:295
#define COAP_DEPRECATED
Definition: libcoap.h:53
#define COAP_STATIC_INLINE
Definition: libcoap.h:45
uint8_t short_opts[COAP_OPT_FILTER_SHORT]
Definition: coap_option.h:104
uint16_t long_opts[COAP_OPT_FILTER_LONG]
Definition: coap_option.h:103
Iterator to run through PDU options.
Definition: coap_option.h:171
coap_opt_t * next_option
pointer to the unparsed next option
Definition: coap_option.h:176
coap_opt_filter_t filter
option filter
Definition: coap_option.h:177
unsigned int bad
iterator object is ok if not set
Definition: coap_option.h:174
size_t length
remaining length of PDU
Definition: coap_option.h:172
unsigned int filtered
denotes whether or not filter is used
Definition: coap_option.h:175
coap_option_num_t number
decoded option number
Definition: coap_option.h:173
Representation of CoAP options.
Definition: coap_option.h:32
const uint8_t * value
Definition: coap_option.h:35
uint16_t delta
Definition: coap_option.h:33
size_t length
Definition: coap_option.h:34
Representation of chained list of CoAP options to install.
Definition: coap_option.h:328
uint16_t number
the option number (no delta coding)
Definition: coap_option.h:330
size_t length
the option value length
Definition: coap_option.h:331
uint8_t * data
the option data
Definition: coap_option.h:332
struct coap_optlist_t * next
next entry in the optlist chain
Definition: coap_option.h:329
structure for CoAP PDUs