libcoap  4.3.0rc2
coap_resource_internal.h
Go to the documentation of this file.
1 /*
2  * coap_resource_internal.h -- generic resource handling
3  *
4  * Copyright (C) 2010,2011,2014-2021 Olaf Bergmann <bergmann@tzi.org>
5  *
6  * This file is part of the CoAP library libcoap. Please see README for terms
7  * of use.
8  */
9 
15 #ifndef COAP_RESOURCE_INTERNAL_H_
16 #define COAP_RESOURCE_INTERNAL_H_
17 
27 struct coap_attr_t {
28  struct coap_attr_t *next;
31  int flags;
32 };
33 
39  unsigned int dirty:1;
40  unsigned int partiallydirty:1;
42  unsigned int observable:1;
43  unsigned int cacheable:1;
44  unsigned int is_unknown:1;
45  unsigned int is_proxy_uri:1;
55 
57 
68  int flags;
74  unsigned int observe;
75 
80 
85 
90 
95  void *user_data;
96 
97 };
98 
105 
106 #define RESOURCES_ADD(r, obj) \
107  HASH_ADD(hh, (r), uri_path->s[0], (obj)->uri_path->length, (obj))
108 
109 #define RESOURCES_DELETE(r, obj) \
110  HASH_DELETE(hh, (r), (obj))
111 
112 #define RESOURCES_ITER(r,tmp) \
113  coap_resource_t *tmp, *rtmp; \
114  HASH_ITER(hh, (r), tmp, rtmp)
115 
116 #define RESOURCES_FIND(r, k, res) { \
117  HASH_FIND(hh, (r), (k)->s, (k)->length, (res)); \
118  }
119 
127 void coap_delete_attr(coap_attr_t *attr);
128 
130  unsigned char *,
131  size_t *, size_t,
132  coap_opt_t *);
133 
134 
137 #endif /* COAP_RESOURCE_INTERNAL_H_ */
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:169
void coap_delete_all_resources(coap_context_t *context)
Deletes all resources from given context and frees their storage.
Definition: resource.c:588
void coap_delete_attr(coap_attr_t *attr)
Deletes an attribute.
Definition: resource.c:466
void(* coap_method_handler_t)(coap_context_t *, coap_resource_t *, coap_session_t *, coap_pdu_t *, coap_binary_t *, coap_string_t *, coap_pdu_t *)
Definition of message handler function.
Definition: resource.h:41
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:325
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
Abstraction of attribute associated with a resource.
coap_str_const_t * value
Value of the attribute (can be NULL)
struct coap_attr_t * next
Pointer to next in chain or NULL.
coap_str_const_t * name
Name of the attribute.
The CoAP stack's global state is stored in a coap_context_t object.
Abstraction of resource that can be attached to coap_context_t.
unsigned int dirty
set to 1 if resource has changed
unsigned int partiallydirty
set to 1 if some subscribers have not yet been notified of the last change
coap_subscription_t * subscribers
list of observers for this resource
void * user_data
This pointer is under user control.
coap_str_const_t ** proxy_name_list
Array valid names this host is known by (proxy support)
coap_str_const_t * uri_path
Request URI Path for this resource.
unsigned int observe
The next value for the Observe option.
unsigned int cacheable
can be cached
coap_context_t * context
Pointer back to the context that 'owns' this resource.
coap_method_handler_t handler[7]
Used to store handlers for the seven coap methods GET, POST, PUT, DELETE, FETCH, PATCH and IPATCH.
unsigned int is_proxy_uri
resource created for proxy URI handler
unsigned int is_unknown
resource created for unknown handler
coap_attr_t * link_attr
attributes to be included with the link format
unsigned int observable
can be observed
size_t proxy_name_count
Count of valid names this host is known by (proxy support)
int flags
zero or more COAP_RESOURCE_FLAGS_* or'd together
CoAP string data definition with const data.
Definition: str.h:38
Subscriber information.