- Generated on Wed Oct 14 2026 12:10:49 by
1.13.2
Read, set, and add option accessors for IANA-defined options. More...
Read, set, and add option accessors for IANA-defined options.
Block-wise Transfers | |
| typedef uint32_t | unicoap_block_option_t |
Block1 and Block2 option value | |
| static ssize_t | unicoap_options_t::unicoap_options_get_block (const unicoap_options_t *options, unicoap_option_number_t number, unicoap_block_option_t *block) |
Retrieves a Block1 or Block2 option. | |
| static int | unicoap_options_t::unicoap_options_set_block (unicoap_options_t *options, unicoap_option_number_t number, unicoap_block_option_t block) |
Sets the Block1 or Block2 option. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_block1 (const unicoap_options_t *options, unicoap_block_option_t *block) |
Retrieves the Block1 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_block1 (unicoap_options_t *options, unicoap_block_option_t block) |
Sets the Block1 option. | |
| static int | unicoap_options_t::unicoap_options_remove_block1 (unicoap_options_t *options) |
Removes the Block1 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_block2 (const unicoap_options_t *options, unicoap_block_option_t *block) |
Retrieves the Block2 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_block2 (unicoap_options_t *options, unicoap_block_option_t block) |
Sets the Block2 option. | |
| static int | unicoap_options_t::unicoap_options_remove_block2 (unicoap_options_t *options) |
Removes the Block2 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_size1 (const unicoap_options_t *options, uint32_t *size) |
Retrieves the Size1 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_size1 (unicoap_options_t *options, uint32_t size) |
Sets the Size1 option. | |
| static int | unicoap_options_t::unicoap_options_remove_size1 (unicoap_options_t *options) |
Removes the Size1 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_size2 (const unicoap_options_t *options, uint32_t *size) |
Retrieves the Size2 option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_size2 (unicoap_options_t *options, uint32_t size) |
Sets the Size2 option. | |
| static int | unicoap_options_t::unicoap_options_remove_size2 (unicoap_options_t *options) |
Removes the Size2 option, if present. | |
| #define | UNICOAP_BLOCK_OPTION_NONE (0x0f000000) |
| Sentinel value for unicoap_block_option_t indicating an uninitialized value. | |
Uri-Host | |
| static ssize_t | unicoap_options_t::unicoap_options_get_uri_host (const unicoap_options_t *options, const char **host) |
Retrieves the Uri-Host option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_uri_host (unicoap_options_t *options, const char *host, size_t length) |
Sets the Uri-Host option. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_uri_host_string (unicoap_options_t *options, const char *host) |
Sets the Uri-Host option from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_uri_host (unicoap_options_t *options) |
Removes the Uri-Host option, if present. | |
If-None-Match | |
| static bool | unicoap_options_t::unicoap_options_get_if_none_match (const unicoap_options_t *options) |
Determines whether the If-None-Match option is present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_if_none_match (unicoap_options_t *options, bool value) |
Sets the If-None-Match option. | |
Uri-Port | |
| static ssize_t | unicoap_options_t::unicoap_options_get_uri_port (const unicoap_options_t *options, uint16_t *port) |
Retrieves the Uri-Port option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_uri_port (unicoap_options_t *options, uint16_t port) |
Sets the Uri-Port option. | |
| static int | unicoap_options_t::unicoap_options_remove_uri_port (unicoap_options_t *options) |
Removes the Uri-Port option, if present. | |
Content-Format | |
| static ssize_t | unicoap_options_t::unicoap_options_get_content_format (const unicoap_options_t *options, unicoap_content_format_t *format) |
Retrieves the Content-Format option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_content_format (unicoap_options_t *options, unicoap_content_format_t format) |
Sets the Content-Format option. | |
| static int | unicoap_options_t::unicoap_options_remove_content_format (unicoap_options_t *options) |
Removes the Content-Format option, if present. | |
Max-Age | |
| static ssize_t | unicoap_options_t::unicoap_options_get_max_age (const unicoap_options_t *options, uint32_t *age) |
Retrieves the Max-Age option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_max_age (unicoap_options_t *options, uint32_t age) |
Sets the Max-Age option. | |
| static int | unicoap_options_t::unicoap_options_remove_max_age (unicoap_options_t *options) |
Removes the Max-Age option, if present. | |
Accept | |
| static ssize_t | unicoap_options_t::unicoap_options_get_accept (const unicoap_options_t *options, unicoap_content_format_t *format) |
Retrieves the Accept option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_accept (unicoap_options_t *options, unicoap_content_format_t format) |
Sets the Accept option. | |
| static int | unicoap_options_t::unicoap_options_remove_accept (unicoap_options_t *options) |
Removes the Accept option, if present. | |
Proxy-Scheme | |
| static ssize_t | unicoap_options_t::unicoap_options_get_proxy_scheme (const unicoap_options_t *options, const char **scheme) |
Retrieves the Proxy-Scheme option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_proxy_scheme (unicoap_options_t *options, const char *scheme, size_t length) |
Sets the Proxy-Scheme option. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_proxy_scheme_string (unicoap_options_t *options, const char *scheme) |
Sets the Proxy-Scheme option from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_proxy_scheme (unicoap_options_t *options) |
Removes the Proxy-Scheme option, if present. | |
Proxy-Uri | |
| static ssize_t | unicoap_options_t::unicoap_options_get_proxy_uri (const unicoap_options_t *options, const char **uri) |
Retrieves the Proxy-Uri option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_proxy_uri (unicoap_options_t *options, const char *uri, size_t length) |
Sets the Proxy-Uri option. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_proxy_uri_string (unicoap_options_t *options, const char *uri) |
Sets the Proxy-Uri option from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_proxy_uri (unicoap_options_t *options) |
Removes the Proxy-Uri option, if present. | |
No-Response | |
| static ssize_t | unicoap_options_t::unicoap_options_get_no_response (const unicoap_options_t *options, uint8_t *value) |
Retrieves the No-Response option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_no_response (unicoap_options_t *options, uint8_t value) |
Sets the No-Response option. | |
| static int | unicoap_options_t::unicoap_options_remove_no_response (unicoap_options_t *options) |
Removes the No-Response option, if present. | |
If-Match | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_if_match (const unicoap_options_t *options, const uint8_t **value) |
Retrieves the first If-Match option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_if_match (unicoap_options_iterator_t *iterator, const uint8_t **value) |
Gets the next If-Match option provided by the specified iterator. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_if_match (unicoap_options_t *options, const uint8_t *value, size_t size) |
Adds If-Match option. | |
| static int | unicoap_options_t::unicoap_options_remove_all_if_match (unicoap_options_t *options) |
Removes all If-Match options, if any. | |
ETag | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_etag (const unicoap_options_t *options, const uint8_t **etag) |
Retrieves the first ETag option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_etag (unicoap_options_iterator_t *iterator, const uint8_t **etag) |
Gets the next ETag option provided by the specified iterator. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_etag (unicoap_options_t *options, const uint8_t *etag, size_t size) |
Adds ETag option. | |
| static int | unicoap_options_t::unicoap_options_remove_etags (unicoap_options_t *options) |
Removes all ETag options, if any. | |
Location-Path | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_location_path_component (const unicoap_options_t *options, const char **component) |
Retrieves the first Location-Path option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_location_path_component (unicoap_options_iterator_t *iterator, const char **component) |
Gets the next Location-Path option provided by the specified iterator. | |
| static ssize_t | unicoap_options_t::unicoap_options_copy_location_path (const unicoap_options_t *options, char *path, size_t capacity) |
| Copies absolute location path into the given buffer. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_path_component (unicoap_options_t *options, const char *component, size_t length) |
Adds Location-Path option. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_path_component_string (unicoap_options_t *options, const char *component) |
Adds Location-Path option from null-terminated string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_path (unicoap_options_t *options, const char *path, size_t length) |
Adds multiple Location-Path options from string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_path_string (unicoap_options_t *options, const char *path) |
Adds multiple Location-Path options from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_location_path (unicoap_options_t *options) |
Removes all Location-Path options, if any. | |
Uri-Path | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_uri_path_component (const unicoap_options_t *options, const char **component) |
Retrieves the first Uri-Path option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_uri_path_component (unicoap_options_iterator_t *iterator, const char **component) |
Gets the next Uri-Path option provided by the specified iterator. | |
| static ssize_t | unicoap_options_t::unicoap_options_copy_uri_path (const unicoap_options_t *options, char *path, size_t capacity) |
| Copies absolute URI path into the given buffer. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_path_component (unicoap_options_t *options, const char *component, size_t length) |
Adds Uri-Path option. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_path_component_string (unicoap_options_t *options, const char *component) |
Adds Uri-Path option from null-terminated string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_path (unicoap_options_t *options, const char *path, size_t length) |
Adds multiple Uri-Path options from string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_path_string (unicoap_options_t *options, const char *path) |
Adds multiple Uri-Path options from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_uri_path (unicoap_options_t *options) |
Removes all Uri-Path options, if any. | |
Uri-Query | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_uri_query (const unicoap_options_t *options, const char **query) |
Retrieves the first Uri-Query option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_uri_query (unicoap_options_iterator_t *iterator, const char **query) |
Gets the next Uri-Query option provided by the specified iterator. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_uri_query_by_name (unicoap_options_iterator_t *iterator, const char *name, size_t length, const char **value) |
Gets the next Uri-Query option matching the given name, potentially skipping any options in between. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_uri_query_by_name_string (unicoap_options_iterator_t *iterator, const char *name, const char **value) |
Gets the next Uri-Query option matching the given name, potentially skipping any options in between. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_uri_query_by_name (unicoap_options_t *options, const char *name, size_t length, const char **value) |
Retrieves the first Uri-Query option matching the given name,if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_uri_query_by_name_string (unicoap_options_t *options, const char *name, const char **value) |
Retrieves the first Uri-Query option matching the given null-terminated name,if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_copy_uri_queries (const unicoap_options_t *options, char *queries, size_t capacity) |
| Copies URI query string into the given buffer. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_query (unicoap_options_t *options, const char *query, size_t length) |
Adds Uri-Query option. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_query_string (unicoap_options_t *options, const char *query) |
Adds Uri-Query option from null-terminated string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_queries (unicoap_options_t *options, const char *queries, size_t length) |
Adds multiple Uri-Query options from string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_uri_queries_string (unicoap_options_t *options, const char *queries) |
Adds multiple Uri-Query options from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_uri_queries (unicoap_options_t *options) |
Removes all Uri-Query options, if any. | |
Location-Query | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_location_query (const unicoap_options_t *options, const char **query) |
Retrieves the first Location-Query option, if present. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_location_query (unicoap_options_iterator_t *iterator, const char **query) |
Gets the next Location-Query option provided by the specified iterator. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_location_query_by_name (unicoap_options_iterator_t *iterator, const char *name, size_t length, const char **value) |
Gets the next Location-Query option matching the given name, potentially skipping any options in between. | |
| static ssize_t | unicoap_options_iterator_t::unicoap_options_get_next_location_query_by_name_string (unicoap_options_iterator_t *iterator, const char *name, const char **value) |
Gets the next Location-Query option matching the given name, potentially skipping any options in between. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_location_query_by_name (unicoap_options_t *options, const char *name, size_t length, const char **value) |
Retrieves the first Location-Query option matching the given name,if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_get_first_location_query_by_name_string (unicoap_options_t *options, const char *name, const char **value) |
Retrieves the first Location-Query option matching the given null-terminated name,if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_copy_location_queries (const unicoap_options_t *options, char *queries, size_t capacity) |
| Copies location query string into the given buffer. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_query (unicoap_options_t *options, const char *query, size_t length) |
Adds Location-Query option. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_query_string (unicoap_options_t *options, const char *query) |
Adds Location-Query option from null-terminated string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_queries (unicoap_options_t *options, const char *queries, size_t length) |
Adds multiple Location-Query options from string. | |
| static ssize_t | unicoap_options_t::unicoap_options_add_location_queries_string (unicoap_options_t *options, const char *queries) |
Adds multiple Location-Query options from null-terminated string. | |
| static int | unicoap_options_t::unicoap_options_remove_location_queries (unicoap_options_t *options) |
Removes all Location-Query options, if any. | |
Observe | |
| static ssize_t | unicoap_options_t::unicoap_options_get_observe (const unicoap_options_t *options, uint32_t *observe) |
Retrieves the Observe option, if present. | |
| static ssize_t | unicoap_options_t::unicoap_options_set_observe (unicoap_options_t *options, uint32_t observe) |
Sets the Observe option. | |
| static int | unicoap_options_t::unicoap_options_remove_observe (unicoap_options_t *options) |
Removes the Observe option, if present. | |
| int | unicoap_options_t::unicoap_options_set_observe_generated (unicoap_options_t *options) |
Sets the Observe option to a randomly generated value. | |
| #define | UNICOAP_OBSERVE_OPTION_REGISTER (0) |
| Observe value for registering for notifications. | |
| #define | UNICOAP_OBSERVE_OPTION_DEREGISTER (1) |
| Observe value for cancelling a registration for notifications. | |
| #define UNICOAP_BLOCK_OPTION_NONE (0x0f000000) |
Sentinel value for unicoap_block_option_t indicating an uninitialized value.
Block1 or Block2 value. Definition at line 1756 of file generated.h.
| #define UNICOAP_OBSERVE_OPTION_DEREGISTER (1) |
Observe value for cancelling a registration for notifications.
Definition at line 1682 of file generated.h.
| #define UNICOAP_OBSERVE_OPTION_REGISTER (0) |
Observe value for registering for notifications.
Definition at line 1679 of file generated.h.
| typedef uint32_t unicoap_block_option_t |
Block1 and Block2 option value
Definition at line 1761 of file generated.h.
Content-Format option values
| Enumerator | |
|---|---|
| UNICOAP_FORMAT_TEXT | Content type Media type: |
| UNICOAP_FORMAT_COSE_ENCRYPT0 | Content type Media type:
|
| UNICOAP_FORMAT_COSE_MAC0 | Content type Media type:
|
| UNICOAP_FORMAT_COSE_SIGN1 | Content type Media type:
|
| UNICOAP_FORMAT_ACE_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_IMAGE_GIF | Content type Media type: |
| UNICOAP_FORMAT_IMAGE_JPEG | Content type Media type:
|
| UNICOAP_FORMAT_IMAGE_PNG | Content type Media type:
|
| UNICOAP_FORMAT_LINK | Content type Media type:
|
| UNICOAP_FORMAT_XML | Content type Media type:
|
| UNICOAP_FORMAT_OCTET_STREAM | Content type Media type: |
| UNICOAP_FORMAT_EXI | Content type Media type: |
| UNICOAP_FORMAT_JSON | Content type Media type:
|
| UNICOAP_FORMAT_JSON_PATCH_JSON | Content type Media type:
|
| UNICOAP_FORMAT_MERGE_PATCH_JSON | Content type Media type:
|
| UNICOAP_FORMAT_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_CWT | Content type Media type:
|
| UNICOAP_FORMAT_MULTIPART_CORE | Content type Media type:
|
| UNICOAP_FORMAT_CBOR_SEQ | Content type Media type:
|
| UNICOAP_FORMAT_EDHOC_CBOR_SEQ | Content type Media type:
|
| UNICOAP_FORMAT_CID_EDHOC_CBOR_SEQ | Content type Media type:
|
| UNICOAP_FORMAT_COSE_ENCRYPT | Content type Media type:
|
| UNICOAP_FORMAT_COSE_MAC | Content type Media type:
|
| UNICOAP_FORMAT_COSE_SIGN | Content type Media type:
|
| UNICOAP_FORMAT_COSE_KEY | Content type Media type:
|
| UNICOAP_FORMAT_COSE_KEY_SET | Content type Media type:
|
| UNICOAP_FORMAT_SENML_JSON | Content type Media type:
|
| UNICOAP_FORMAT_SENSML_JSON | Content type Media type:
|
| UNICOAP_FORMAT_SENML_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_SENSML_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_SENML_EXI | Content type Media type:
|
| UNICOAP_FORMAT_SENSML_EXI | Content type Media type:
|
| UNICOAP_FORMAT_YANG_DATA_CBOR_SID | Content type Media type:
|
| UNICOAP_FORMAT_COAP_GROUP_JSON | Content type Media type:
|
| UNICOAP_FORMAT_CONCISE_PROBLEM_DETAILS_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_SWID_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_PKIXCMP | Content type Media type: |
| UNICOAP_FORMAT_YANG_SID_JSON | Content type Media type:
|
| UNICOAP_FORMAT_ACE_GROUPCOMM_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_ACE_TRL_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_EAT_CWT | Content type Media type:
|
| UNICOAP_FORMAT_EAT_JWT | Content type Media type:
|
| UNICOAP_FORMAT_EAT_BUN_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_EAT_BUN_JSON | Content type Media type:
|
| UNICOAP_FORMAT_EAT_UCS_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_EAT_UCS_JSON | Content type Media type:
|
| UNICOAP_FORMAT_COAP_EAP | Content type Media type:
|
| UNICOAP_FORMAT_SUIT_REPORT_COSE | Content type Media type:
|
| UNICOAP_FORMAT_DOTS_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_MISSING_BLOCKS_CBOR_SEQ | Content type Media type:
|
| UNICOAP_FORMAT_CMW_CBOR | Content type Media type: |
| UNICOAP_FORMAT_CMW_JSON | Content type Media type: |
| UNICOAP_FORMAT_CMW_COSE | Content type Media type: |
| UNICOAP_FORMAT_CMW_JWS | Content type Media type: |
| UNICOAP_FORMAT_SCITT_STATEMENT_COSE | Content type Media type:
|
| UNICOAP_FORMAT_SCITT_RECEIPT_COSE | Content type Media type:
|
| UNICOAP_FORMAT_STATUSLIST_CWT | Content type Media type:
|
| UNICOAP_FORMAT_PKCS7_MIME_SERVER_GENERATED_KEY | Content type Media type: |
| UNICOAP_FORMAT_PKCS7_MIME_CERTS_ONLY | Content type Media type: |
| UNICOAP_FORMAT_PKCS8 | Content type Media type: |
| UNICOAP_FORMAT_CSRATTRS | Content type Media type: |
| UNICOAP_FORMAT_PKCS10 | Content type Media type: |
| UNICOAP_FORMAT_PKIX_CERT | Content type Media type: |
| UNICOAP_FORMAT_AIF_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_AIF_JSON | Content type Media type:
|
| UNICOAP_FORMAT_AIF_CBOR_CRI_LOCAL_PART | Content type Media type:
|
| UNICOAP_FORMAT_SD_CWT_ | Content type Media type: |
| UNICOAP_FORMAT_KB_CWT_ | Content type Media type: |
| UNICOAP_FORMAT_MEASURED_COMPONENT_CBOR | Content type Media type: |
| UNICOAP_FORMAT_MEASURED_COMPONENT_JSON | Content type Media type: |
| UNICOAP_FORMAT_AIF_CBOR_OSCORE_GNAME_OSCORE_GPERM | Content type Media type: |
| UNICOAP_FORMAT_AIF_JSON_OSCORE_GNAME_OSCORE_GPERM | Content type Media type: |
| UNICOAP_FORMAT_SENML_XML | Content type Media type:
|
| UNICOAP_FORMAT_SENSML_XML | Content type Media type:
|
| UNICOAP_FORMAT_SENML_ETCH_JSON | Content type Media type:
|
| UNICOAP_FORMAT_SENML_ETCH_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_YANG_DATA_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_YANG_DATA_CBOR_NAME | Content type Media type:
|
| UNICOAP_FORMAT_TD_JSON | Content type Media type: |
| UNICOAP_FORMAT_TM_JSON | Content type Media type: |
| UNICOAP_FORMAT_SDF_JSON | Content type Media type:
|
| UNICOAP_FORMAT_DNS_MESSAGE | Content type Media type:
|
| UNICOAP_FORMAT_UCCS_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_VOUCHER_COSE_ | Content type Media type: |
| UNICOAP_FORMAT_OCF_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_OSCORE | Content type Media type:
|
| UNICOAP_FORMAT_JAVASCRIPT | Content type Media type:
|
| UNICOAP_FORMAT_EAT_CWT_PSA2023_PROFILE | Content type Media type:
|
| UNICOAP_FORMAT_EAT_CWT_PSA2019_PROFILE | Content type Media type:
|
| UNICOAP_FORMAT_EAT_CWT_PROFILE_PROFILE | Content type Media type: |
| UNICOAP_FORMAT_OMS_CELLULAR_COSE_CONTENT_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_SYSLOG_MSG | Content type Media type: |
| UNICOAP_FORMAT_TOC_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_CE_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_TOC_CBOR_PROFILE | Content type Media type: |
| UNICOAP_FORMAT_CE_CBOR_PROFILE | Content type Media type: |
| UNICOAP_FORMAT_JSON_DEFLATE | Content type Media type:
|
| UNICOAP_FORMAT_CBOR_DEFLATE | Content type Media type:
|
| UNICOAP_FORMAT_OMA_LWM2M_TLV | Content type Media type:
|
| UNICOAP_FORMAT_OMA_LWM2M_JSON | Content type Media type:
|
| UNICOAP_FORMAT_OMA_LWM2M_CBOR | Content type Media type:
|
| UNICOAP_FORMAT_TEXT_ZSTD | Content type Media type:
|
| UNICOAP_FORMAT_XML_ZSTD | Content type Media type:
|
| UNICOAP_FORMAT_JSON_ZSTD | Content type Media type:
|
| UNICOAP_FORMAT_TEXT_CSS | Content type Media type:
|
| UNICOAP_FORMAT_AS207960_VAS_CONFIG_JER | Content type Media type:
|
| UNICOAP_FORMAT_AS207960_VAS_CONFIG_UPER | Content type Media type:
|
| UNICOAP_FORMAT_AS207960_VAS_TAP_JER | Content type Media type:
|
| UNICOAP_FORMAT_AS207960_VAS_TAP_UPER | Content type Media type:
|
| UNICOAP_FORMAT_IMAGE_SVG_XML | Content type Media type: |
Definition at line 709 of file constants.h.
|
inlinestatic |
Determines whether the given Content-Format is based on CBOR.
| format | Content-Format value |
Definition at line 1645 of file constants.h.
|
inlinestatic |
Determines whether the given Content-Format is human-readable.
| format | Content-Format value |
Definition at line 1703 of file constants.h.
|
inlinestatic |
Determines whether the given Content-Format is based on JSON.
| format | Content-Format value |
Definition at line 1615 of file constants.h.
|
inlinestatic |
Determines whether the given Content-Format is based on XML.
| format | Content-Format value |
Definition at line 1688 of file constants.h.
|
inlinestatic |
Adds ETag option.
| [in,out] | options | Options to write to |
| [in] | etag | ETag value |
| size | Number of bytes in etag in bytes |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
etag must be at least of size 1 bytes etag size must not exceed 8 bytes Definition at line 743 of file generated.h.
|
inlinestatic |
Adds If-Match option.
| [in,out] | options | Options to write to |
| [in] | value | If-Match value |
| size | Number of bytes in value in bytes |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
value size must not exceed 8 bytes Definition at line 663 of file generated.h.
|
inlinestatic |
Adds multiple Location-Path options from string.
| [in,out] | options | Options to write to |
| [in] | path | as buffer of UTF-8 code units with values separated by / |
| length | Number of UTF-8 code units in path, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function.
Definition at line 893 of file generated.h.
|
inlinestatic |
Adds Location-Path option.
| [in,out] | options | Options to write to |
| [in] | component | Location-Path value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in component, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
Definition at line 852 of file generated.h.
|
inlinestatic |
Adds Location-Path option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | component | Location-Path value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
Uses strlen to calculate the number of code units.
Definition at line 873 of file generated.h.
|
inlinestatic |
Adds multiple Location-Path options from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | path | as null-terminated string of UTF-8 code units with values separated by / |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function. Uses strlen to calculate the number of code units.
Definition at line 915 of file generated.h.
|
inlinestatic |
Adds multiple Location-Query options from string.
| [in,out] | options | Options to write to |
| [in] | queries | as buffer of UTF-8 code units with values separated by & |
| length | Number of UTF-8 code units in queries, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function.
Definition at line 1628 of file generated.h.
|
inlinestatic |
Adds multiple Location-Query options from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | queries | as null-terminated string of UTF-8 code units with values separated by & |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function. Uses strlen to calculate the number of code units.
Definition at line 1651 of file generated.h.
|
inlinestatic |
Adds Location-Query option.
| [in,out] | options | Options to write to |
| [in] | query | Location-Query value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in query, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
query size must not exceed 255 bytes Definition at line 1584 of file generated.h.
|
inlinestatic |
Adds Location-Query option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | query | Location-Query value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
query size must not exceed 255 bytesUses strlen to calculate the number of code units.
Definition at line 1607 of file generated.h.
|
inlinestatic |
Adds multiple Uri-Path options from string.
| [in,out] | options | Options to write to |
| [in] | path | as buffer of UTF-8 code units with values separated by / |
| length | Number of UTF-8 code units in path, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function.
Definition at line 1068 of file generated.h.
|
inlinestatic |
Adds Uri-Path option.
| [in,out] | options | Options to write to |
| [in] | component | Uri-Path value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in component, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
component size must not exceed 255 bytes Definition at line 1024 of file generated.h.
|
inlinestatic |
Adds Uri-Path option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | component | Uri-Path value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
component size must not exceed 255 bytesUses strlen to calculate the number of code units.
Definition at line 1047 of file generated.h.
|
inlinestatic |
Adds multiple Uri-Path options from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | path | as null-terminated string of UTF-8 code units with values separated by / |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function. Uses strlen to calculate the number of code units.
Definition at line 1091 of file generated.h.
|
inlinestatic |
Adds multiple Uri-Query options from string.
| [in,out] | options | Options to write to |
| [in] | queries | as buffer of UTF-8 code units with values separated by & |
| length | Number of UTF-8 code units in queries, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function.
Definition at line 1348 of file generated.h.
|
inlinestatic |
Adds multiple Uri-Query options from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | queries | as null-terminated string of UTF-8 code units with values separated by & |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
If the string with the values you want to add starts with the separator, you can still use this function. Uses strlen to calculate the number of code units.
Definition at line 1371 of file generated.h.
|
inlinestatic |
Adds Uri-Query option.
| [in,out] | options | Options to write to |
| [in] | query | Uri-Query value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in query, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
query size must not exceed 255 bytes Definition at line 1304 of file generated.h.
|
inlinestatic |
Adds Uri-Query option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | query | Uri-Query value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to add options |
query size must not exceed 255 bytesUses strlen to calculate the number of code units.
Definition at line 1327 of file generated.h.
|
inlinestatic |
Copies absolute location path into the given buffer.
| [in] | options | Options to read from |
| [in,out] | path | Buffer of UTF-8 code units |
| capacity | Capacity of path |
| `-EBADOPT` | Option corrupted |
| `-ENOBUFS` | path lacks sufficient capacity to copy values |
capacity must be greater than zeroThis function creates a string from all Location-Path options by joining them with the / separator. The string will bear the / prefix even if there is no Location-Path option. The string will not be null-terminated. The resulting string uses UTF-8 encoding.
Definition at line 826 of file generated.h.
|
inlinestatic |
Copies location query string into the given buffer.
| [in] | options | Options to read from |
| [in,out] | queries | Buffer of UTF-8 code units |
| capacity | Capacity of queries |
| `-EBADOPT` | Option corrupted |
| `-ENOBUFS` | queries lacks sufficient capacity to copy values |
This function creates a string from all Location-Query options by joining them with the & separator. The string will not be null-terminated. The resulting string uses UTF-8 encoding.
Definition at line 1561 of file generated.h.
|
inlinestatic |
Copies absolute URI path into the given buffer.
| [in] | options | Options to read from |
| [in,out] | path | Buffer of UTF-8 code units |
| capacity | Capacity of path |
| `-EBADOPT` | Option corrupted |
| `-ENOBUFS` | path lacks sufficient capacity to copy values |
capacity must be greater than zeroThis function creates a string from all Uri-Path options by joining them with the / separator. The string will bear the / prefix even if there is no Uri-Path option. The string will not be null-terminated. The resulting string uses UTF-8 encoding.
Definition at line 997 of file generated.h.
|
inlinestatic |
Copies URI query string into the given buffer.
| [in] | options | Options to read from |
| [in,out] | queries | Buffer of UTF-8 code units |
| capacity | Capacity of queries |
| `-EBADOPT` | Option corrupted |
| `-ENOBUFS` | queries lacks sufficient capacity to copy values |
This function creates a string from all Uri-Query options by joining them with the & separator. The string will not be null-terminated. The resulting string uses UTF-8 encoding.
Definition at line 1281 of file generated.h.
|
inlinestatic |
Retrieves the Accept option, if present.
| [in] | options | Options to read from |
| [out] | format | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 350 of file generated.h.
|
inlinestatic |
Retrieves a Block1 or Block2 option.
| [in] | options | Options to read from |
| number | Option number (UNICOAP_OPTION_BLOCK1 or UNICOAP_OPTION_BLOCK2) | |
| [out] | block | Pointer to variable that will store Block1 or Block2 value |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1775 of file generated.h.
|
inlinestatic |
Retrieves the Block1 option, if present.
| [in] | options | Options to read from |
| [out] | block | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1814 of file generated.h.
|
inlinestatic |
Retrieves the Block2 option, if present.
| [in] | options | Options to read from |
| [out] | block | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1862 of file generated.h.
|
inlinestatic |
Retrieves the Content-Format option, if present.
| [in] | options | Options to read from |
| [out] | format | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 240 of file generated.h.
|
inlinestatic |
Retrieves the first ETag option, if present.
| [in] | options | Options to read from |
| [out] | etag | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 702 of file generated.h.
|
inlinestatic |
Retrieves the first If-Match option, if present.
| [in] | options | Options to read from |
| [out] | value | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 623 of file generated.h.
|
inlinestatic |
Retrieves the first Location-Path option, if present.
| [in] | options | Options to read from |
| [out] | component | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 782 of file generated.h.
|
inlinestatic |
Retrieves the first Location-Query option, if present.
| [in] | options | Options to read from |
| [out] | query | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1409 of file generated.h.
|
inlinestatic |
Retrieves the first Location-Query option matching the given name,if present.
This method splits Location-Query options at the = character.
| [in] | options | Options to read from |
| [in] | name | Name of query parameter to find |
| length | Number of UTF-8 code units (bytes) in name | |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished and no matching Location-Query option was found |
Definition at line 1504 of file generated.h.
|
inlinestatic |
Retrieves the first Location-Query option matching the given null-terminated name,if present.
This method splits Location-Query options at the = character.
| [in] | options | Options to read from |
| [in] | name | Name of query parameter to find, must be null-terminated |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished and no matching Location-Query option was found |
Definition at line 1535 of file generated.h.
|
inlinestatic |
Retrieves the first Uri-Path option, if present.
| [in] | options | Options to read from |
| [out] | component | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 953 of file generated.h.
|
inlinestatic |
Retrieves the first Uri-Query option, if present.
| [in] | options | Options to read from |
| [out] | query | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1129 of file generated.h.
|
inlinestatic |
Retrieves the first Uri-Query option matching the given name,if present.
This method splits Uri-Query options at the = character.
| [in] | options | Options to read from |
| [in] | name | Name of query parameter to find |
| length | Number of UTF-8 code units (bytes) in name | |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished and no matching Uri-Query option was found |
Definition at line 1224 of file generated.h.
|
inlinestatic |
Retrieves the first Uri-Query option matching the given null-terminated name,if present.
This method splits Uri-Query options at the = character.
| [in] | options | Options to read from |
| [in] | name | Name of query parameter to find, must be null-terminated |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished and no matching Uri-Query option was found |
Definition at line 1255 of file generated.h.
|
inlinestatic |
Determines whether the If-None-Match option is present.
| [in] | options | Options to read from |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 140 of file generated.h.
|
inlinestatic |
Retrieves the Max-Age option, if present.
| [in] | options | Options to read from |
| [out] | age | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 295 of file generated.h.
|
inlinestatic |
Gets the next ETag option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | etag | Pointer to a variable that will store next etag |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 722 of file generated.h.
|
inlinestatic |
Gets the next If-Match option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | value | Pointer to a variable that will store next value |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 643 of file generated.h.
|
inlinestatic |
Gets the next Location-Path option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | component | Pointer to a variable that will store next component |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 802 of file generated.h.
|
inlinestatic |
Gets the next Location-Query option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | query | Pointer to a variable that will store next query |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1429 of file generated.h.
|
inlinestatic |
Gets the next Location-Query option matching the given name, potentially skipping any options in between.
This method splits Location-Query options at the = character.
| [in,out] | iterator | Option iterator |
| [in] | name | Name of query parameter to find |
| length | Number of UTF-8 code units (bytes) in name | |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1451 of file generated.h.
|
inlinestatic |
Gets the next Location-Query option matching the given name, potentially skipping any options in between.
This method splits Location-Query options at the = character.
| [in,out] | iterator | Option iterator |
| [in] | name | Name of query parameter to find, must be null-terminated |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1475 of file generated.h.
|
inlinestatic |
Gets the next Uri-Path option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | component | Pointer to a variable that will store next component |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 973 of file generated.h.
|
inlinestatic |
Gets the next Uri-Query option provided by the specified iterator.
| [in,out] | iterator | Option iterator |
| [out] | query | Pointer to a variable that will store next query |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1149 of file generated.h.
|
inlinestatic |
Gets the next Uri-Query option matching the given name, potentially skipping any options in between.
This method splits Uri-Query options at the = character.
| [in,out] | iterator | Option iterator |
| [in] | name | Name of query parameter to find |
| length | Number of UTF-8 code units (bytes) in name | |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1171 of file generated.h.
|
inlinestatic |
Gets the next Uri-Query option matching the given name, potentially skipping any options in between.
This method splits Uri-Query options at the = character.
| [in,out] | iterator | Option iterator |
| [in] | name | Name of query parameter to find, must be null-terminated |
| [out] | value | Pointer to a UTF-8 string variable that will store the entire option, including the name= part |
| `-EBADOPT` | Option corrupted |
| `-1` | if the iterator is finished |
Definition at line 1195 of file generated.h.
|
inlinestatic |
Retrieves the No-Response option, if present.
| [in] | options | Options to read from |
| [out] | value | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 568 of file generated.h.
|
inlinestatic |
Retrieves the Observe option, if present.
| [in] | options | Options to read from |
| [out] | observe | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1695 of file generated.h.
|
inlinestatic |
Retrieves the Proxy-Scheme option, if present.
| [in] | options | Options to read from |
| [out] | scheme | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 405 of file generated.h.
|
inlinestatic |
Retrieves the Proxy-Uri option, if present.
| [in] | options | Options to read from |
| [out] | uri | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 484 of file generated.h.
|
inlinestatic |
Retrieves the Size1 option, if present.
| [in] | options | Options to read from |
| [out] | size | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1910 of file generated.h.
|
inlinestatic |
Retrieves the Size2 option, if present.
| [in] | options | Options to read from |
| [out] | size | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 1958 of file generated.h.
|
inlinestatic |
Retrieves the Uri-Host option, if present.
| [in] | options | Options to read from |
| [out] | host | Pointer to value variable as buffer of UTF-8 code units |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 57 of file generated.h.
|
inlinestatic |
Retrieves the Uri-Port option, if present.
| [in] | options | Options to read from |
| [out] | port | Pointer to value variable |
| `-ENOENT` | Option not found |
| `-EBADOPT` | Option corrupted |
Definition at line 185 of file generated.h.
|
inlinestatic |
Removes the Accept option, if present.
| [in,out] | options | Options to write to |
Definition at line 382 of file generated.h.
|
inlinestatic |
Removes all If-Match options, if any.
| [in,out] | options | Options to write to |
Definition at line 679 of file generated.h.
|
inlinestatic |
Removes the Block1 option, if present.
| [in,out] | options | Options to write to |
Definition at line 1846 of file generated.h.
|
inlinestatic |
Removes the Block2 option, if present.
| [in,out] | options | Options to write to |
Definition at line 1894 of file generated.h.
|
inlinestatic |
Removes the Content-Format option, if present.
| [in,out] | options | Options to write to |
Definition at line 272 of file generated.h.
|
inlinestatic |
Removes all ETag options, if any.
| [in,out] | options | Options to write to |
Definition at line 759 of file generated.h.
|
inlinestatic |
Removes all Location-Path options, if any.
| [in,out] | options | Options to write to |
Definition at line 930 of file generated.h.
|
inlinestatic |
Removes all Location-Query options, if any.
| [in,out] | options | Options to write to |
Definition at line 1666 of file generated.h.
|
inlinestatic |
Removes the Max-Age option, if present.
| [in,out] | options | Options to write to |
Definition at line 327 of file generated.h.
|
inlinestatic |
Removes the No-Response option, if present.
| [in,out] | options | Options to write to |
Definition at line 600 of file generated.h.
|
inlinestatic |
Removes the Observe option, if present.
| [in,out] | options | Options to write to |
Definition at line 1727 of file generated.h.
|
inlinestatic |
Removes the Proxy-Scheme option, if present.
| [in,out] | options | Options to write to |
Definition at line 461 of file generated.h.
|
inlinestatic |
Removes the Proxy-Uri option, if present.
| [in,out] | options | Options to write to |
Definition at line 545 of file generated.h.
|
inlinestatic |
Removes the Size1 option, if present.
| [in,out] | options | Options to write to |
Definition at line 1942 of file generated.h.
|
inlinestatic |
Removes the Size2 option, if present.
| [in,out] | options | Options to write to |
Definition at line 1990 of file generated.h.
|
inlinestatic |
Removes the Uri-Host option, if present.
| [in,out] | options | Options to write to |
Definition at line 118 of file generated.h.
|
inlinestatic |
Removes all Uri-Path options, if any.
| [in,out] | options | Options to write to |
Definition at line 1106 of file generated.h.
|
inlinestatic |
Removes the Uri-Port option, if present.
| [in,out] | options | Options to write to |
Definition at line 217 of file generated.h.
|
inlinestatic |
Removes all Uri-Query options, if any.
| [in,out] | options | Options to write to |
Definition at line 1386 of file generated.h.
|
inlinestatic |
Sets the Accept option.
| [in,out] | options | Options to write to |
| format | Accept value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 367 of file generated.h.
|
inlinestatic |
Sets the Block1 or Block2 option.
| [in,out] | options | Options to write to |
| number | Option number (UNICOAP_OPTION_BLOCK1 or UNICOAP_OPTION_BLOCK2) | |
| block | Block1 or Block2 value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1794 of file generated.h.
|
inlinestatic |
Sets the Block1 option.
| [in,out] | options | Options to write to |
| block | Block1 value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1831 of file generated.h.
|
inlinestatic |
Sets the Block2 option.
| [in,out] | options | Options to write to |
| block | Block2 value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1879 of file generated.h.
|
inlinestatic |
Sets the Content-Format option.
| [in,out] | options | Options to write to |
| format | Content-Format value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 257 of file generated.h.
|
inlinestatic |
Sets the If-None-Match option.
| [in,out] | options | Options to write to |
| value | If-None-Match value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 155 of file generated.h.
|
inlinestatic |
Sets the Max-Age option.
| [in,out] | options | Options to write to |
| age | Max-Age value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 312 of file generated.h.
|
inlinestatic |
Sets the No-Response option.
| [in,out] | options | Options to write to |
| value | No-Response value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 585 of file generated.h.
|
inlinestatic |
Sets the Observe option.
| [in,out] | options | Options to write to |
| observe | Observe value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1712 of file generated.h.
| int unicoap_options_set_observe_generated | ( | unicoap_options_t * | options | ) |
Sets the Observe option to a randomly generated value.
| [in] | options | Options to read from |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
|
inlinestatic |
Sets the Proxy-Scheme option.
| [in,out] | options | Options to write to |
| [in] | scheme | Proxy-Scheme value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in scheme, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 425 of file generated.h.
|
inlinestatic |
Sets the Proxy-Scheme option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | scheme | Proxy-Scheme value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Uses strlen to calculate the number of code units.
Definition at line 446 of file generated.h.
|
inlinestatic |
Sets the Proxy-Uri option.
| [in,out] | options | Options to write to |
| [in] | uri | Proxy-Uri value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in uri, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
uri must be at least of size 1 bytes uri size must not exceed 1034 bytes Definition at line 506 of file generated.h.
|
inlinestatic |
Sets the Proxy-Uri option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | uri | Proxy-Uri value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
uri must be at least of size 1 bytes uri size must not exceed 1034 bytesUses strlen to calculate the number of code units.
Definition at line 530 of file generated.h.
|
inlinestatic |
Sets the Size1 option.
| [in,out] | options | Options to write to |
| size | Size1 value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1927 of file generated.h.
|
inlinestatic |
Sets the Size2 option.
| [in,out] | options | Options to write to |
| size | Size2 value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 1975 of file generated.h.
|
inlinestatic |
Sets the Uri-Host option.
| [in,out] | options | Options to write to |
| [in] | host | Uri-Host value as buffer of UTF-8 code units |
| length | Number of UTF-8 code units in host, excluding null-terminator (if present) in bytes without potential null-terminator |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
host must be at least of size 1 bytes host size must not exceed 255 bytes Definition at line 79 of file generated.h.
|
inlinestatic |
Sets the Uri-Host option from null-terminated string.
| [in,out] | options | Options to write to |
| [in] | host | Uri-Host value as buffer of UTF-8 code units, must be null-terminated |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
host must be at least of size 1 bytes host size must not exceed 255 bytesUses strlen to calculate the number of code units.
Definition at line 103 of file generated.h.
|
inlinestatic |
Sets the Uri-Port option.
| [in,out] | options | Options to write to |
| port | Uri-Port value |
| `-ENOBUFS` | Options buffer lacks sufficient capacity to set option |
Definition at line 202 of file generated.h.
1.13.2