libcoap
4.1.2
|
#include "coap_config.h"
#include "coap.h"
#include "debug.h"
#include "mem.h"
#include "net.h"
#include "resource.h"
#include "subscribe.h"
#include "utlist.h"
Go to the source code of this file.
Macros | |
#define | COAP_MALLOC_TYPE(Type) ((coap_##Type##_t *)coap_malloc(sizeof(coap_##Type##_t))) |
#define | COAP_FREE_TYPE(Type, Object) coap_free(Object) |
#define | min(a, b) ((a) < (b) ? (a) : (b)) |
#define | PRINT_WITH_OFFSET(Buf, Offset, Char) |
Adds Char to Buf if Offset is zero. More... | |
#define | PRINT_COND_WITH_OFFSET(Buf, Bufend, Offset, Char, Result) |
Adds Char to Buf if Offset is zero and Buf is less than Bufend. More... | |
#define | COPY_COND_WITH_OFFSET(Buf, Bufend, Offset, Str, Length, Result) |
Copies at most Length characters of Str to Buf. More... | |
#define | MATCH_URI 0x01 |
#define | MATCH_PREFIX 0x02 |
#define | MATCH_SUBSTRING 0x04 |
#define | INET6_ADDRSTRLEN 40 |
Functions | |
static int | match (const str *text, const str *pattern, int match_prefix, int match_substring) |
coap_print_status_t | coap_print_wellknown (coap_context_t *context, unsigned char *buf, size_t *buflen, size_t offset, coap_opt_t *query_filter) |
Prints the names of all known resources to buf . More... | |
coap_resource_t * | coap_resource_init (const unsigned char *uri, size_t len, int flags) |
Creates a new resource object and initializes the link field to the string of length len . More... | |
coap_attr_t * | coap_add_attr (coap_resource_t *resource, const unsigned char *name, size_t nlen, const unsigned char *val, size_t vlen, int flags) |
Registers a new attribute with the given resource . More... | |
coap_attr_t * | coap_find_attr (coap_resource_t *resource, const unsigned char *name, size_t nlen) |
Returns resource's coap_attr_t object with given name if found, NULL otherwise. More... | |
void | coap_delete_attr (coap_attr_t *attr) |
Deletes an attribute. More... | |
void | coap_hash_request_uri (const coap_pdu_t *request, coap_key_t key) |
Calculates the hash key for the resource requested by the Uri-Options of request . More... | |
void | coap_add_resource (coap_context_t *context, coap_resource_t *resource) |
Registers the given resource for context . More... | |
static void | coap_free_resource (coap_resource_t *resource) |
int | coap_delete_resource (coap_context_t *context, coap_key_t key) |
Deletes a resource identified by key . More... | |
void | coap_delete_all_resources (coap_context_t *context) |
Deletes all resources from given context and frees their storage. More... | |
coap_resource_t * | coap_get_resource_from_key (coap_context_t *context, coap_key_t key) |
Returns the resource identified by the unique string key . More... | |
coap_print_status_t | coap_print_link (const coap_resource_t *resource, unsigned char *buf, size_t *len, size_t *offset) |
Writes a description of this resource in link-format to given text buffer. More... | |
coap_subscription_t * | coap_find_observer (coap_resource_t *resource, const coap_address_t *peer, const str *token) |
Returns a subscription object for given peer . More... | |
coap_subscription_t * | coap_add_observer (coap_resource_t *resource, const coap_endpoint_t *local_interface, const coap_address_t *observer, const str *token) |
Adds the specified peer as observer for resource . More... | |
void | coap_touch_observer (coap_context_t *context, const coap_address_t *observer, const str *token) |
Marks an observer as alive. More... | |
int | coap_delete_observer (coap_resource_t *resource, const coap_address_t *observer, const str *token) |
Removes any subscription for observer from resource and releases the allocated storage. More... | |
static void | coap_notify_observers (coap_context_t *context, coap_resource_t *r) |
void | coap_check_notify (coap_context_t *context) |
Checks for all known resources, if they are dirty and notifies subscribed observers. More... | |
static void | coap_remove_failed_observers (coap_context_t *context, coap_resource_t *resource, const coap_address_t *peer, const str *token) |
Checks the failure counter for (peer, token) and removes peer from the list of observers for the given resource when COAP_OBS_MAX_FAIL is reached. More... | |
void | coap_handle_failed_notify (coap_context_t *context, const coap_address_t *peer, const str *token) |
#define COAP_FREE_TYPE | ( | Type, | |
Object | |||
) | coap_free(Object) |
Definition at line 36 of file resource.c.
#define COAP_MALLOC_TYPE | ( | Type | ) | ((coap_##Type##_t *)coap_malloc(sizeof(coap_##Type##_t))) |
Definition at line 34 of file resource.c.
#define COPY_COND_WITH_OFFSET | ( | Buf, | |
Bufend, | |||
Offset, | |||
Str, | |||
Length, | |||
Result | |||
) |
Copies at most Length characters of Str to Buf.
The first Offset characters are skipped. Output may be truncated to Bufend - Buf characters.
Definition at line 97 of file resource.c.
#define INET6_ADDRSTRLEN 40 |
#define MATCH_PREFIX 0x02 |
#define MATCH_SUBSTRING 0x04 |
#define MATCH_URI 0x01 |
#define min | ( | a, | |
b | |||
) | ((a) < (b) ? (a) : (b)) |
Definition at line 65 of file resource.c.
#define PRINT_COND_WITH_OFFSET | ( | Buf, | |
Bufend, | |||
Offset, | |||
Char, | |||
Result | |||
) |
Adds Char to Buf if Offset is zero and Buf is less than Bufend.
Definition at line 85 of file resource.c.
#define PRINT_WITH_OFFSET | ( | Buf, | |
Offset, | |||
Char | |||
) |
Adds Char to Buf if Offset is zero.
Otherwise, Char is not written and Offset is decremented.
Definition at line 75 of file resource.c.
coap_attr_t* coap_add_attr | ( | coap_resource_t * | resource, |
const unsigned char * | name, | ||
size_t | nlen, | ||
const unsigned char * | val, | ||
size_t | vlen, | ||
int | flags | ||
) |
Registers a new attribute with the given resource
.
As the attributes str fields will point to name
and val
the caller must ensure that these pointers are valid during the attribute's lifetime.
resource | The resource to register the attribute with. |
name | The attribute's name. |
nlen | Length of name . |
val | The attribute's value or NULL if none. |
vlen | Length of val if specified. |
flags | Flags for memory management (in particular release of memory). |
NULL
on error. Definition at line 314 of file resource.c.
coap_subscription_t* coap_add_observer | ( | coap_resource_t * | resource, |
const coap_endpoint_t * | local_interface, | ||
const coap_address_t * | observer, | ||
const str * | token | ||
) |
Adds the specified peer as observer for resource
.
The subscription is identified by the given token
. This function returns the registered subscription information if the observer
has been added, or NULL
on error.
resource | The observed resource. |
local_interface | The local network interface where the observer is attached to. |
observer | The remote peer that wants to received status updates. |
token | The token that identifies this subscription. |
NULL
on error. Definition at line 542 of file resource.c.
void coap_add_resource | ( | coap_context_t * | context, |
coap_resource_t * | resource | ||
) |
Registers the given resource
for context
.
The resource must have been created by coap_resource_init(), the storage allocated for the resource will be released by coap_delete_resource().
context | The context to use. |
resource | The resource to store. |
Definition at line 399 of file resource.c.
void coap_check_notify | ( | coap_context_t * | context | ) |
Checks for all known resources, if they are dirty and notifies subscribed observers.
Definition at line 689 of file resource.c.
void coap_delete_all_resources | ( | coap_context_t * | context | ) |
Deletes all resources from given context
and frees their storage.
context | The CoAP context with the resources to be deleted. |
Definition at line 449 of file resource.c.
void coap_delete_attr | ( | coap_attr_t * | attr | ) |
Deletes an attribute.
attr | Pointer to a previously created attribute. |
Definition at line 366 of file resource.c.
int coap_delete_observer | ( | coap_resource_t * | resource, |
const coap_address_t * | observer, | ||
const str * | token | ||
) |
Removes any subscription for observer
from resource
and releases the allocated storage.
The result is 1
if an observation relationship with observer
and token
existed, 0
otherwise.
resource | The observed resource. |
observer | The observer's address. |
token | The token that identifies this subscription or NULL for any token. |
1
if the observer has been deleted, 0
otherwise. Definition at line 593 of file resource.c.
int coap_delete_resource | ( | coap_context_t * | context, |
coap_key_t | key | ||
) |
Deletes a resource identified by key
.
The storage allocated for that resource is freed.
context | The context where the resources are stored. |
key | The unique key for the resource to delete. |
1
if the resource was found (and destroyed), 0
otherwise. Definition at line 428 of file resource.c.
coap_attr_t* coap_find_attr | ( | coap_resource_t * | resource, |
const unsigned char * | name, | ||
size_t | nlen | ||
) |
Returns resource's
coap_attr_t object with given name
if found, NULL
otherwise.
resource | The resource to search for attribute name . |
name | Name of the requested attribute. |
nlen | Actual length of name . |
name
or NULL
if none was found. Definition at line 349 of file resource.c.
coap_subscription_t* coap_find_observer | ( | coap_resource_t * | resource, |
const coap_address_t * | peer, | ||
const str * | token | ||
) |
Returns a subscription object for given peer
.
resource | The observed resource. |
peer | The address to search for. |
token | The token that identifies this subscription or NULL for any token. |
NULL
otherwise. Definition at line 524 of file resource.c.
|
static |
Definition at line 404 of file resource.c.
coap_resource_t* coap_get_resource_from_key | ( | coap_context_t * | context, |
coap_key_t | key | ||
) |
Returns the resource identified by the unique string key
.
If no resource was found, this function returns NULL
.
context | The context to look for this resource. |
key | The unique key of the resource. |
NULL
if not found. Definition at line 469 of file resource.c.
void coap_handle_failed_notify | ( | coap_context_t * | context, |
const coap_address_t * | peer, | ||
const str * | token | ||
) |
Definition at line 748 of file resource.c.
void coap_hash_request_uri | ( | const coap_pdu_t * | request, |
coap_key_t | key | ||
) |
Calculates the hash key for the resource requested by the Uri-Options of request
.
This function calls coap_hash() for every path segment.
request | The requesting pdu. |
key | The resulting hash is stored in key . |
Definition at line 383 of file resource.c.
|
static |
Definition at line 609 of file resource.c.
coap_print_status_t coap_print_link | ( | const coap_resource_t * | resource, |
unsigned char * | buf, | ||
size_t * | len, | ||
size_t * | offset | ||
) |
Writes a description of this resource in link-format to given text buffer.
len
must be initialized to the maximum length of buf
and will be set to the number of characters actually written if successful. This function returns 1
on success or 0
on error.
resource | The resource to describe. |
buf | The output buffer to write the description to. |
len | Must be initialized to the length of buf and will be set to the length of the printed link description. |
offset | The offset within the resource description where to start writing into buf . This is useful for dealing with the Block2 option. offset is updated during output as it is consumed. |
buffer
. The flag COAP_PRINT_STATUS_TRUNC indicates that the output has been truncated. Definition at line 478 of file resource.c.
coap_print_status_t coap_print_wellknown | ( | coap_context_t * | context, |
unsigned char * | buf, | ||
size_t * | buflen, | ||
size_t | offset, | ||
coap_opt_t * | query_filter | ||
) |
Prints the names of all known resources to buf
.
This function sets buflen
to the number of bytes actually written and returns 1
on succes. On error, the value in buflen
is undefined and the return value will be 0
.
context | The context with the resource map. |
buf | The buffer to write the result. |
buflen | Must be initialized to the maximum length of buf and will be set to the length of the well-known response on return. |
offset | The offset in bytes where the output shall start and is shifted accordingly with the characters that have been processed. This parameter is used to support the block option. |
query_filter | A filter query according to Link Format |
buf
. COAP_PRINT_STATUS_TRUNC is set when the output has been truncated. Definition at line 167 of file resource.c.
|
static |
Checks the failure counter for (peer, token) and removes peer from the list of observers for the given resource when COAP_OBS_MAX_FAIL is reached.
context | The CoAP context to use |
resource | The resource to check for (peer, token) |
peer | The observer's address |
token | The token that has been used for subscription. |
Definition at line 707 of file resource.c.
coap_resource_t* coap_resource_init | ( | const unsigned char * | uri, |
size_t | len, | ||
int | flags | ||
) |
Creates a new resource object and initializes the link field to the string of length len
.
This function returns the new coap_resource_t object.
uri | The URI path of the new resource. |
len | The length of uri . |
flags | Flags for memory management (in particular release of memory). |
NULL
on error. Definition at line 288 of file resource.c.
void coap_touch_observer | ( | coap_context_t * | context, |
const coap_address_t * | observer, | ||
const str * | token | ||
) |
Marks an observer as alive.
context | The CoAP context to use. |
observer | The transport address of the observer. |
token | The corresponding token that has been used for the subscription. |
Definition at line 580 of file resource.c.
|
static |
Definition at line 105 of file resource.c.