coap_str.h

Go to the documentation of this file.

/*
 * str.h -- strings to be used in the CoAP library
 *
 * Copyright (C) 2010-2011 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_STR_H_
#define COAP_STR_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Note: string and binary use equivalent objects.
 * string is likely to contain readable textual information, binary will not.
 */
 
typedef struct coap_string_t {
  size_t length;    
  uint8_t *s;       
} coap_string_t;
 
typedef struct coap_str_const_t {
  size_t length;    
  const uint8_t *s; 
} coap_str_const_t;
 
#define COAP_SET_STR(st,l,v) { (st)->length = (l), (st)->s = (v); }
 
typedef struct coap_binary_t {
  size_t length;    
  uint8_t *s;       
} coap_binary_t;
 
typedef struct coap_bin_const_t {
  size_t length;    
  const uint8_t *s; 
} coap_bin_const_t;
 
typedef union {
  coap_string_t st;
  coap_str_const_t sc;
  coap_binary_t bt;
  coap_bin_const_t bc;
} coap_str_bin_union_t;
 
typedef union {
  const char *s_byte;    
  const uint8_t *u_byte; 
} coap_const_char_ptr_t;
 
coap_string_t *coap_new_string(size_t size);
 
void coap_delete_string(coap_string_t *string);
 
coap_str_const_t *coap_new_str_const(const uint8_t *data, size_t size);
 
void coap_delete_str_const(coap_str_const_t *string);
 
coap_binary_t *coap_new_binary(size_t size);
 
void coap_delete_binary(coap_binary_t *binary);
 
coap_binary_t *coap_resize_binary(coap_binary_t *binary, size_t new_size);
 
coap_bin_const_t *coap_new_bin_const(const uint8_t *data, size_t size);
 
void coap_delete_bin_const(coap_bin_const_t *binary);
 
#ifndef COAP_MAX_STR_CONST_FUNC
#define COAP_MAX_STR_CONST_FUNC 2
#endif /* COAP_MAX_STR_CONST_FUNC */
 
coap_str_const_t *coap_make_str_const(const char *string);
 
#define coap_string_equal(string1,string2) \
  ((string1)->length == (string2)->length && ((string1)->length == 0 || \
                                              ((string1)->s && (string2)->s && \
                                               memcmp((string1)->s, (string2)->s, (string1)->length) == 0)))
 
#define coap_binary_equal(binary1,binary2) \
  ((binary1)->length == (binary2)->length && ((binary1)->length == 0 || \
                                              ((binary1)->s && (binary2)->s && \
                                               memcmp((binary1)->s, (binary2)->s, (binary1)->length) == 0)))
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_STR_H_ */