option.h
Go to the documentation of this file.
/*
* option.h -- helpers for handling options in CoAP PDUs
*
* Copyright (C) 2010-2013 Olaf Bergmann <bergmann@tzi.org>
*
* This file is part of the CoAP library libcoap. Please see README for terms
* of use.
*/
#ifndef COAP_OPTION_H_
#define COAP_OPTION_H_
#include "bits.h"
#include "pdu.h"
typedef uint8_t coap_opt_t;
#define PCHAR(p) ((coap_opt_t *)(p))
typedef struct {
uint16_t delta;
size_t length;
const uint8_t *value;
} coap_option_t;
size_t coap_opt_parse(const coap_opt_t *opt,
size_t length,
coap_option_t *result);
size_t coap_opt_size(const coap_opt_t *opt);
#define COAP_OPT_FILTER_SHORT 6
#define COAP_OPT_FILTER_LONG 2
/* Ensure that COAP_OPT_FILTER_SHORT and COAP_OPT_FILTER_LONG are set
* correctly. */
#if (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16)
#error COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG must be less or equal 16
#endif /* (COAP_OPT_FILTER_SHORT + COAP_OPT_FILTER_LONG > 16) */
#define COAP_OPT_FILTER_SIZE \
(((COAP_OPT_FILTER_SHORT + 1) >> 1) + COAP_OPT_FILTER_LONG) +1
typedef uint16_t coap_opt_filter_t[COAP_OPT_FILTER_SIZE];
#define COAP_OPT_ALL NULL
COAP_STATIC_INLINE void
coap_option_filter_clear(coap_opt_filter_t f) {
memset(f, 0, sizeof(coap_opt_filter_t));
}
int coap_option_filter_set(coap_opt_filter_t filter, uint16_t type);
int coap_option_filter_unset(coap_opt_filter_t filter, uint16_t type);
int coap_option_filter_get(coap_opt_filter_t filter, uint16_t type);
COAP_STATIC_INLINE int
coap_option_setb(coap_opt_filter_t filter, uint16_t type) {
return coap_option_filter_set(filter, type) ? 1 : -1;
}
COAP_STATIC_INLINE int
coap_option_clrb(coap_opt_filter_t filter, uint16_t type) {
return coap_option_filter_unset(filter, type) ? 1 : -1;
}
COAP_STATIC_INLINE int
coap_option_getb(coap_opt_filter_t filter, uint16_t type) {
return coap_option_filter_get(filter, type);
}
typedef struct {
size_t length;
uint16_t type;
unsigned int bad:1;
unsigned int filtered:1;
coap_opt_t *next_option;
coap_opt_filter_t filter;
} coap_opt_iterator_t;
coap_opt_iterator_t *coap_option_iterator_init(const coap_pdu_t *pdu,
coap_opt_iterator_t *oi,
const coap_opt_filter_t filter);
coap_opt_t *coap_option_next(coap_opt_iterator_t *oi);
coap_opt_t *coap_check_option(coap_pdu_t *pdu,
uint16_t type,
coap_opt_iterator_t *oi);
size_t coap_opt_setheader(coap_opt_t *opt,
size_t maxlen,
uint16_t delta,
size_t length);
size_t coap_opt_encode_size(uint16_t delta, size_t length);
size_t coap_opt_encode(coap_opt_t *opt,
size_t n,
uint16_t delta,
const uint8_t *val,
size_t length);
uint16_t coap_opt_delta(const coap_opt_t *opt);
uint16_t coap_opt_length(const coap_opt_t *opt);
const uint8_t *coap_opt_value(const coap_opt_t *opt);
typedef struct coap_optlist_t {
struct coap_optlist_t *next;
uint16_t number;
size_t length;
uint8_t *data;
} coap_optlist_t;
coap_optlist_t *coap_new_optlist(uint16_t number,
size_t length,
const uint8_t *data);
int coap_add_optlist_pdu(coap_pdu_t *pdu, coap_optlist_t** optlist_chain);
int coap_insert_optlist(coap_optlist_t **optlist_chain,
coap_optlist_t *optlist);
void coap_delete_optlist(coap_optlist_t *optlist_chain);
#endif /* COAP_OPTION_H_ */
coap_optlist_t::length
size_t length
the option value length
Definition: option.h:411
coap_opt_t
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
coap_option_clrb
COAP_STATIC_INLINE int coap_option_clrb(coap_opt_filter_t filter, uint16_t type)
Clears the corresponding bit for type in filter.
Definition: option.h:200
coap_opt_size
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:310
coap_opt_parse
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
coap_option_setb
COAP_STATIC_INLINE int coap_option_setb(coap_opt_filter_t filter, uint16_t type)
Sets the corresponding bit for type in filter.
Definition: option.h:183
coap_delete_optlist
void coap_delete_optlist(coap_optlist_t *optlist_chain)
Removes all entries from the optlist_chain, freeing off their memory usage.
Definition: option.c:610
coap_insert_optlist
int coap_insert_optlist(coap_optlist_t **optlist_chain, coap_optlist_t *optlist)
Adds optlist to the given optlist_chain.
Definition: option.c:589
coap_optlist_t::next
struct coap_optlist_t * next
next entry in the optlist chain
Definition: option.h:409
coap_option_t::value
const uint8_t * value
Definition: option.h:34
coap_opt_iterator_t::length
size_t length
remaining length of PDU
Definition: option.h:238
coap_option_filter_set
int coap_option_filter_set(coap_opt_filter_t filter, uint16_t type)
Sets the corresponding entry for type in filter.
Definition: option.c:523
coap_option_next
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
coap_new_optlist
coap_optlist_t * coap_new_optlist(uint16_t number, size_t length, const uint8_t *data)
Create a new optlist entry.
Definition: option.c:540
coap_opt_iterator_t::filter
coap_opt_filter_t filter
option filter
Definition: option.h:243
COAP_OPT_FILTER_SIZE
#define COAP_OPT_FILTER_SIZE
The number of elements in coap_opt_filter_t.
Definition: option.h:93
coap_opt_iterator_t::type
uint16_t type
decoded option type
Definition: option.h:239
coap_optlist_t
struct coap_optlist_t coap_optlist_t
Representation of chained list of CoAP options to install.
coap_optlist_t
Representation of chained list of CoAP options to install.
Definition: option.h:408
coap_opt_encode_size
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:377
coap_check_option
coap_opt_t * coap_check_option(coap_pdu_t *pdu, uint16_t type, coap_opt_iterator_t *oi)
Retrieves the first option of type type from pdu.
Definition: option.c:196
coap_option_t::delta
uint16_t delta
Definition: option.h:32
coap_pdu_t
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Definition: pdu.h:287
coap_option_filter_get
int coap_option_filter_get(coap_opt_filter_t filter, uint16_t type)
Checks if type is contained in filter.
Definition: option.c:533
coap_opt_length
uint16_t coap_opt_length(const coap_opt_t *opt)
Returns the length of the given option.
Definition: option.c:238
coap_option_t::length
size_t length
Definition: option.h:33
coap_option_t
Representation of CoAP options.
Definition: option.h:31
coap_opt_delta
uint16_t coap_opt_delta(const coap_opt_t *opt)
Decodes the delta value of the next option.
Definition: option.c:209
coap_optlist_t::data
uint8_t * data
the option data
Definition: option.h:412
coap_add_optlist_pdu
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:573
coap_opt_iterator_t::next_option
coap_opt_t * next_option
pointer to the unparsed next option
Definition: option.h:242
coap_opt_iterator_t
Iterator to run through PDU options.
Definition: option.h:237
coap_opt_iterator_t::bad
unsigned int bad
iterator object is ok if not set
Definition: option.h:240
coap_option_filter_unset
int coap_option_filter_unset(coap_opt_filter_t filter, uint16_t type)
Clears the corresponding entry for type in filter.
Definition: option.c:528
coap_option_filter_clear
COAP_STATIC_INLINE void coap_option_filter_clear(coap_opt_filter_t f)
Clears filter f.
Definition: option.h:130
coap_optlist_t::number
uint16_t number
the option number (no delta coding)
Definition: option.h:410
COAP_STATIC_INLINE
#define COAP_STATIC_INLINE
Definition: libcoap.h:38
pdu.h
Pre-defined constants that reflect defaults for CoAP.
coap_opt_iterator_t::filtered
unsigned int filtered
denotes whether or not filter is used
Definition: option.h:241
coap_opt_filter_t
uint16_t coap_opt_filter_t[COAP_OPT_FILTER_SIZE]
Fixed-size vector we use for option filtering.
Definition: option.h:119
coap_option_getb
COAP_STATIC_INLINE int coap_option_getb(coap_opt_filter_t filter, uint16_t type)
Gets the corresponding bit for type in filter.
Definition: option.h:217
coap_opt_encode
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:398
coap_opt_setheader
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:318
coap_opt_value
const uint8_t * coap_opt_value(const coap_opt_t *opt)
Returns a pointer to the value of the given option.
Definition: option.c:275
bits.h
Bit vector manipulation.
uint8_t
unsigned char uint8_t
Definition: uthash.h:79
coap_option_iterator_init
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&#39;s option list...
Definition: option.c:110