coap_resource_internal.h
Go to the documentation of this file.
/*
* coap_resource_internal.h -- generic resource handling
*
* Copyright (C) 2010,2011,2014-2021 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_RESOURCE_INTERNAL_H_
#define COAP_RESOURCE_INTERNAL_H_
#include "uthash.h"
struct coap_attr_t {
struct coap_attr_t *next;
coap_str_const_t *name;
coap_str_const_t *value;
int flags;
};
struct coap_resource_t {
unsigned int dirty:1;
unsigned int partiallydirty:1;
unsigned int observable:1;
unsigned int cacheable:1;
unsigned int is_unknown:1;
unsigned int is_proxy_uri:1;
coap_method_handler_t handler[7];
UT_hash_handle hh;
coap_attr_t *link_attr;
coap_subscription_t *subscribers;
coap_str_const_t *uri_path;
int flags;
unsigned int observe;
coap_context_t *context;
size_t proxy_name_count;
coap_str_const_t ** proxy_name_list;
void *user_data;
};
void coap_delete_all_resources(coap_context_t *context);
#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) \
coap_resource_t *tmp, *rtmp; \
HASH_ITER(hh, (r), tmp, rtmp)
#define RESOURCES_FIND(r, k, res) { \
HASH_FIND(hh, (r), (k)->s, (k)->length, (res)); \
}
void coap_delete_attr(coap_attr_t *attr);
coap_print_status_t coap_print_wellknown(coap_context_t *,
unsigned char *,
size_t *, size_t,
coap_opt_t *);
#endif /* COAP_RESOURCE_INTERNAL_H_ */
coap_print_wellknown
coap_print_status_t coap_print_wellknown(coap_context_t *, unsigned char *, size_t *, size_t, coap_opt_t *)
Prints the names of all known resources to buf.
Definition: resource.c:171
coap_delete_all_resources
void coap_delete_all_resources(coap_context_t *context)
Deletes all resources from given context and frees their storage.
Definition: resource.c:590
coap_delete_attr
void coap_delete_attr(coap_attr_t *attr)
Deletes an attribute.
Definition: resource.c:468
coap_print_status_t
unsigned int coap_print_status_t
Status word to encode the result of conditional print or copy operations such as coap_print_link().
Definition: resource.h:324
coap_method_handler_t
void(* coap_method_handler_t)(coap_resource_t *, coap_session_t *, const coap_pdu_t *, const coap_string_t *, coap_pdu_t *)
Definition of message handler function.
Definition: resource.h:42
coap_opt_t
uint8_t coap_opt_t
Use byte-oriented access methods here because sliding a complex struct coap_opt_t over the data buffe...
Definition: option.h:26
coap_attr_t
Abstraction of attribute associated with a resource.
Definition: coap_resource_internal.h:31
coap_attr_t::value
coap_str_const_t * value
Value of the attribute (can be NULL)
Definition: coap_resource_internal.h:34
coap_attr_t::next
struct coap_attr_t * next
Pointer to next in chain or NULL.
Definition: coap_resource_internal.h:32
coap_attr_t::name
coap_str_const_t * name
Name of the attribute.
Definition: coap_resource_internal.h:33
coap_attr_t::flags
int flags
Definition: coap_resource_internal.h:35
coap_context_t
The CoAP stack's global state is stored in a coap_context_t object.
Definition: coap_net_internal.h:45
coap_resource_t
Abstraction of resource that can be attached to coap_context_t.
Definition: coap_resource_internal.h:42
coap_resource_t::dirty
unsigned int dirty
set to 1 if resource has changed
Definition: coap_resource_internal.h:43
coap_resource_t::partiallydirty
unsigned int partiallydirty
set to 1 if some subscribers have not yet been notified of the last change
Definition: coap_resource_internal.h:44
coap_resource_t::subscribers
coap_subscription_t * subscribers
list of observers for this resource
Definition: coap_resource_internal.h:63
coap_resource_t::user_data
void * user_data
This pointer is under user control.
Definition: coap_resource_internal.h:99
coap_resource_t::proxy_name_list
coap_str_const_t ** proxy_name_list
Array valid names this host is known by (proxy support)
Definition: coap_resource_internal.h:93
coap_resource_t::uri_path
coap_str_const_t * uri_path
Request URI Path for this resource.
Definition: coap_resource_internal.h:70
coap_resource_t::observe
unsigned int observe
The next value for the Observe option.
Definition: coap_resource_internal.h:78
coap_resource_t::cacheable
unsigned int cacheable
can be cached
Definition: coap_resource_internal.h:47
coap_resource_t::context
coap_context_t * context
Pointer back to the context that 'owns' this resource.
Definition: coap_resource_internal.h:83
coap_resource_t::handler
coap_method_handler_t handler[7]
Used to store handlers for the seven coap methods GET, POST, PUT, DELETE, FETCH, PATCH and IPATCH.
Definition: coap_resource_internal.h:58
coap_resource_t::is_proxy_uri
unsigned int is_proxy_uri
resource created for proxy URI handler
Definition: coap_resource_internal.h:49
coap_resource_t::is_unknown
unsigned int is_unknown
resource created for unknown handler
Definition: coap_resource_internal.h:48
coap_resource_t::link_attr
coap_attr_t * link_attr
attributes to be included with the link format
Definition: coap_resource_internal.h:62
coap_resource_t::observable
unsigned int observable
can be observed
Definition: coap_resource_internal.h:46
coap_resource_t::proxy_name_count
size_t proxy_name_count
Count of valid names this host is known by (proxy support)
Definition: coap_resource_internal.h:88
coap_resource_t::flags
int flags
zero or more COAP_RESOURCE_FLAGS_* or'd together
Definition: coap_resource_internal.h:72
coap_resource_t::hh
UT_hash_handle hh
Definition: coap_resource_internal.h:60
coap_str_const_t
CoAP string data definition with const data.
Definition: str.h:40
coap_subscription_t
Subscriber information.
Definition: coap_subscribe_internal.h:47