libcoap  4.3.1
str.h
Go to the documentation of this file.
1 /*
2  * str.h -- strings to be used in the CoAP library
3  *
4  * Copyright (C) 2010-2011 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_STR_H_
18 #define COAP_STR_H_
19 
20 #include <string.h>
21 
22 
30 /*
31  * Note: string and binary use equivalent objects.
32  * string is likely to contain readable textual information, binary will not.
33  */
34 
38 typedef struct coap_string_t {
39  size_t length;
40  uint8_t *s;
42 
46 typedef struct coap_str_const_t {
47  size_t length;
48  const uint8_t *s;
50 
51 #define COAP_SET_STR(st,l,v) { (st)->length = (l), (st)->s = (v); }
52 
56 typedef struct coap_binary_t {
57  size_t length;
58  uint8_t *s;
60 
64 typedef struct coap_bin_const_t {
65  size_t length;
66  const uint8_t *s;
68 
79 coap_string_t *coap_new_string(size_t size);
80 
86 void coap_delete_string(coap_string_t *string);
87 
98 coap_str_const_t *coap_new_str_const(const uint8_t *data, size_t size);
99 
106 
117 coap_binary_t *coap_new_binary(size_t size);
118 
124 void coap_delete_binary(coap_binary_t *binary);
125 
139 coap_binary_t *coap_resize_binary(coap_binary_t *binary, size_t new_size);
140 
152 coap_bin_const_t *coap_new_bin_const(const uint8_t *data, size_t size);
153 
160 
161 #ifndef COAP_MAX_STR_CONST_FUNC
162 #define COAP_MAX_STR_CONST_FUNC 2
163 #endif /* COAP_MAX_STR_CONST_FUNC */
164 
178 coap_str_const_t *coap_make_str_const(const char *string);
179 
189 #define coap_string_equal(string1,string2) \
190  ((string1)->length == (string2)->length && ((string1)->length == 0 || \
191  ((string1)->s && (string2)->s && \
192  memcmp((string1)->s, (string2)->s, (string1)->length) == 0)))
193 
203 #define coap_binary_equal(binary1,binary2) \
204  ((binary1)->length == (binary2)->length && ((binary1)->length == 0 || \
205  ((binary1)->s && (binary2)->s && \
206  memcmp((binary1)->s, (binary2)->s, (binary1)->length) == 0)))
207 
210 #endif /* COAP_STR_H_ */
coap_string_t * coap_new_string(size_t size)
Returns a new string object with at least size+1 bytes storage allocated.
Definition: str.c:20
void coap_delete_bin_const(coap_bin_const_t *binary)
Deletes the given const binary data and releases any memory allocated.
Definition: str.c:109
void coap_delete_str_const(coap_str_const_t *string)
Deletes the given const string and releases any memory allocated.
Definition: str.c:58
struct coap_str_const_t coap_str_const_t
CoAP string data definition with const data.
void coap_delete_binary(coap_binary_t *binary)
Deletes the given coap_binary_t object and releases any memory allocated.
Definition: str.c:96
coap_bin_const_t * coap_new_bin_const(const uint8_t *data, size_t size)
Take the specified byte array (text) and create a coap_bin_const_t * Returns a new const binary objec...
Definition: str.c:100
struct coap_binary_t coap_binary_t
CoAP binary data definition.
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
Definition: str.c:72
coap_str_const_t * coap_new_str_const(const uint8_t *data, size_t size)
Returns a new const string object with at least size+1 bytes storage allocated, and the provided data...
Definition: str.c:49
struct coap_string_t coap_string_t
CoAP string data definition.
struct coap_bin_const_t coap_bin_const_t
CoAP binary data definition with const data.
void coap_delete_string(coap_string_t *string)
Deletes the given string and releases any memory allocated.
Definition: str.c:45
coap_binary_t * coap_resize_binary(coap_binary_t *binary, size_t new_size)
Resizes the given coap_binary_t object.
Definition: str.c:76
coap_str_const_t * coap_make_str_const(const char *string)
Take the specified byte array (text) and create a coap_str_const_t *.
Definition: str.c:62
CoAP binary data definition with const data.
Definition: str.h:64
size_t length
length of binary data
Definition: str.h:65
const uint8_t * s
read-only binary data
Definition: str.h:66
CoAP binary data definition.
Definition: str.h:56
size_t length
length of binary data
Definition: str.h:57
uint8_t * s
binary data
Definition: str.h:58
CoAP string data definition with const data.
Definition: str.h:46
const uint8_t * s
read-only string data
Definition: str.h:48
size_t length
length of string
Definition: str.h:47
CoAP string data definition.
Definition: str.h:38
uint8_t * s
string data
Definition: str.h:40
size_t length
length of string
Definition: str.h:39