Resources

Internal API for handling resources. More...

Collaboration diagram for Resources:

Data Structures
struct	coap_attr_t
	Limits the number of subscribers for each resource that this server support. More...
struct	coap_resource_t
	Abstraction of resource that can be attached to coap_context_t. More...

Macros
#define	RESOURCES_ADD(r, obj)    HASH_ADD(hh, (r), uri_path->s[0], (obj)->uri_path->length, (obj))
#define	RESOURCES_DELETE(r, obj)    HASH_DELETE(hh, (r), (obj))
#define	RESOURCES_ITER(r, tmp)
#define	RESOURCES_FIND(r, k, res)

Functions
void	coap_add_resource_lkd (coap_context_t *context, coap_resource_t *resource)
	Registers the given resource for context.
int	coap_delete_resource_lkd (coap_context_t *context, coap_resource_t *resource)
	Deletes a resource identified by resource.
void	coap_delete_all_resources (coap_context_t *context)
	Deletes all resources from given context and frees their storage.
void	coap_resource_reference_lkd (coap_resource_t *resource)
	Increment reference counter on a resource.
void	coap_resource_release_lkd (coap_resource_t *resource)
	Decrement reference counter on a resource.
coap_resource_t *	coap_get_resource_from_uri_path_lkd (coap_context_t *context, coap_str_const_t *uri_path)
	Returns the resource identified by the unique string uri_path.
void	coap_delete_attr (coap_attr_t *attr)
	Deletes an attribute.
coap_print_status_t	coap_print_wellknown_lkd (coap_context_t *context, unsigned char *buf, size_t *buflen, size_t offset, const coap_string_t *query_filter)
	Prints the names of all known resources for context to buf.

Detailed Description

Internal API for handling resources.

Macro Definition Documentation

RESOURCES_ADD

#define RESOURCES_ADD	(		r,
			obj
	)		HASH_ADD(hh, (r), uri_path->s[0], (obj)->uri_path->length, (obj))

Definition at line 176 of file coap_resource_internal.h.

RESOURCES_DELETE

#define RESOURCES_DELETE	(		r,
			obj
	)		HASH_DELETE(hh, (r), (obj))

Definition at line 179 of file coap_resource_internal.h.

RESOURCES_FIND

#define RESOURCES_FIND	(		r,
			k,
			res
	)

Value:

    {                     \
    HASH_FIND(hh, (r), (k)->s, (k)->length, (res)); \
  }

Definition at line 186 of file coap_resource_internal.h.

RESOURCES_ITER

#define RESOURCES_ITER	(		r,
			tmp
	)

Value:

  coap_resource_t *tmp, *rtmp; \
  HASH_ITER(hh, (r), tmp, rtmp)

Definition at line 182 of file coap_resource_internal.h.

Function Documentation

coap_add_resource_lkd()

void coap_add_resource_lkd	(	coap_context_t *	context,
		coap_resource_t *	resource
	)

Registers the given resource for context.

The resource must have been created by coap_resource_init() or coap_resource_unknown_init(), the storage allocated for the resource will be released by coap_delete_resource_lkd().

Note: This function must be called in the locked state.

Parameters

context	The context to use.
resource	The resource to store.

coap_delete_all_resources()

void coap_delete_all_resources

(

coap_context_t *

context

)

Deletes all resources from given context and frees their storage.

Parameters

context

The CoAP context with the resources to be deleted.

Here is the caller graph for this function:

coap_delete_attr()

void coap_delete_attr

(

coap_attr_t *

attr

)

Deletes an attribute.

Note: This is for internal use only, as it is not deleted from its chain.

Parameters

attr	Pointer to a previously created attribute.

coap_delete_resource_lkd()

int coap_delete_resource_lkd	(	coap_context_t *	context,
		coap_resource_t *	resource
	)

Deletes a resource identified by resource.

The storage allocated for that resource is freed, and removed from the context.

Note: This function must be called in the locked state.

Parameters

context	This parameter is ignored, but kept for backward compatibility.
resource	The resource to delete.

Returns

1 if the resource was found (and destroyed), 0 otherwise.

coap_get_resource_from_uri_path_lkd()

coap_resource_t * coap_get_resource_from_uri_path_lkd	(	coap_context_t *	context,
		coap_str_const_t *	uri_path
	)

Returns the resource identified by the unique string uri_path.

If no resource was found, this function returns NULL.

Note: This function must be called in the locked state.

Parameters

context	The context to look for this resource.
uri_path	The unique string uri of the resource.

Returns

A pointer to the resource or NULL if not found.

coap_print_wellknown_lkd()

coap_print_status_t coap_print_wellknown_lkd	(	coap_context_t *	context,
		unsigned char *	buf,
		size_t *	buflen,
		size_t	offset,
		const coap_string_t *	query_filter
	)

Prints the names of all known resources for context to buf.

This function sets buflen to the number of bytes actually written and returns COAP_PRINT_STATUS_ERROR on error. On error, the value in buflen is undefined. Otherwise, the lower 28 bits are set to the number of bytes that have actually been written. COAP_PRINT_STATUS_TRUNC is set when the output has been truncated.

Note: This function must be called in the locked state.

Parameters

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

Returns

COAP_PRINT_STATUS_ERROR on error. Otherwise, the lower 28 bits are set to the number of bytes that have actually been written to buf. COAP_PRINT_STATUS_TRUNC is set when the output has been truncated.

coap_resource_reference_lkd()

void coap_resource_reference_lkd

(

coap_resource_t *

resource

)

Increment reference counter on a resource.

Note: This function must be called in the locked state.

Parameters

resource

The CoAP resource.

coap_resource_release_lkd()

void coap_resource_release_lkd

(

coap_resource_t *

resource

)

Decrement reference counter on a resource.

Note that the resource storage may be deleted as a result and should not be used after this call.

Note: This function must be called in the locked state.

Parameters

resource

The CoAP resource.