coap_option.h

Go to the documentation of this file.

/*
 * coap_option.h -- helpers for handling options in CoAP PDUs
 *
 * Copyright (C) 2010-2013,2022-2025 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_OPTION_H_
#define COAP_OPTION_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint16_t coap_option_num_t;
 
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) */
 
/*
 * mask contains a bit vector that indicates which fields in the long_opts[]
 * and subsequent short_opts[] are used. The first COAP_OPT_FILTER_LONG bits
 * correspond to the long option types that are stored in long_opts[]
 * elements. The next COAP_OPT_FILTER_SHORT bits correspond to the short
 * option types that are stored in short_opts[].
 */
typedef struct coap_opt_filter_t {
  uint16_t mask;
  uint16_t long_opts[COAP_OPT_FILTER_LONG];
  uint8_t short_opts[COAP_OPT_FILTER_SHORT];
} coap_opt_filter_t;
 
#define COAP_OPT_ALL NULL
 
void coap_option_filter_clear(coap_opt_filter_t *filter);
 
int coap_option_filter_set(coap_opt_filter_t *filter, coap_option_num_t number);
 
int coap_option_filter_unset(coap_opt_filter_t *filter,
                             coap_option_num_t number);
 
int coap_option_filter_get(coap_opt_filter_t *filter, coap_option_num_t number);
 
typedef struct {
  size_t length;                
  coap_option_num_t number;     
  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(const coap_pdu_t *pdu,
                              coap_option_num_t number,
                              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);
 
uint32_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);
 
COAP_STATIC_INLINE COAP_DEPRECATED int
coap_option_setb(coap_opt_filter_t *filter, uint16_t type) {
  return coap_option_filter_set(filter, type) ? 1 : -1;
}
 
COAP_STATIC_INLINE COAP_DEPRECATED int
coap_option_clrb(coap_opt_filter_t *filter, uint16_t type) {
  return coap_option_filter_unset(filter, type) ? 1 : -1;
}
 
COAP_STATIC_INLINE COAP_DEPRECATED int
coap_option_getb(coap_opt_filter_t *filter, uint16_t type) {
  return coap_option_filter_get(filter, type);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_OPTION_H_ */