libcoap 4.3.0
resource.h
Go to the documentation of this file.
1/*
2 * resource.h -- generic resource handling
3 *
4 * Copyright (C) 2010,2011,2014-2021 Olaf Bergmann <bergmann@tzi.org>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see README for terms
9 * of use.
10 */
11
17#ifndef COAP_RESOURCE_H_
18#define COAP_RESOURCE_H_
19
20#ifndef COAP_RESOURCE_CHECK_TIME
22#define COAP_RESOURCE_CHECK_TIME 2
23#endif /* COAP_RESOURCE_CHECK_TIME */
24
25#include "async.h"
26#include "block.h"
27#include "str.h"
28#include "pdu.h"
29#include "net.h"
30#include "subscribe.h"
31
41typedef void (*coap_method_handler_t)
44 const coap_pdu_t * /* request */,
45 const coap_string_t * /* query string */,
46 coap_pdu_t * /* response */);
47
48#define COAP_ATTR_FLAGS_RELEASE_NAME 0x1
49#define COAP_ATTR_FLAGS_RELEASE_VALUE 0x2
50
52#define COAP_RESOURCE_FLAGS_RELEASE_URI 0x1
53
59#define COAP_RESOURCE_FLAGS_NOTIFY_NON 0x0
60
65#define COAP_RESOURCE_FLAGS_NOTIFY_CON 0x2
66
75#define COAP_RESOURCE_FLAGS_NOTIFY_NON_ALWAYS 0x4
76
109 int flags);
110
111
139
156 size_t host_name_count, const char *host_name_list[]);
157
168 coap_str_const_t *uri_path);
169
178
187void coap_resource_set_mode(coap_resource_t *resource, int mode);
188
197void coap_resource_set_userdata(coap_resource_t *resource, void *data);
198
208
212typedef void (*coap_resource_release_userdata_handler_t)(void *user_data);
213
224
233void coap_add_resource(coap_context_t *context, coap_resource_t *resource);
234
246
256 coap_request_t method,
257 coap_method_handler_t handler);
258
290 coap_str_const_t *name,
291 coap_str_const_t *value,
292 int flags);
293
304 coap_str_const_t *name);
305
314
324typedef unsigned int coap_print_status_t;
325
326#define COAP_PRINT_STATUS_MASK 0xF0000000u
327#define COAP_PRINT_OUTPUT_LENGTH(v) ((v) & ~COAP_PRINT_STATUS_MASK)
328#define COAP_PRINT_STATUS_ERROR 0x80000000u
329#define COAP_PRINT_STATUS_TRUNC 0x40000000u
330
353 unsigned char *buf,
354 size_t *len,
355 size_t *offset);
356
369 coap_str_const_t *uri_path);
370
376 const coap_string_t *query);
377
378#endif /* COAP_RESOURCE_H_ */
State management for asynchronous messages.
coap_resource_t * coap_resource_proxy_uri_init(coap_method_handler_t handler, size_t host_name_count, const char *host_name_list[])
Creates a new resource object for handling proxy URIs.
Definition: resource.c:358
coap_attr_t * coap_add_attr(coap_resource_t *resource, coap_str_const_t *name, coap_str_const_t *value, int flags)
Registers a new attribute with the given resource.
Definition: resource.c:407
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.
Definition: resource.c:624
void coap_resource_set_mode(coap_resource_t *resource, int mode)
Sets the notification message type of resource resource to given mode.
Definition: resource.c:1027
coap_resource_t * coap_get_resource_from_uri_path(coap_context_t *context, coap_str_const_t *uri_path)
Returns the resource identified by the unique string uri_path.
Definition: resource.c:615
void coap_resource_release_userdata_handler(coap_context_t *context, coap_resource_release_userdata_handler_t callback)
Defines the context wide callback to use to when the resource is deleted to release the data held in ...
Definition: resource.c:1044
void coap_register_handler(coap_resource_t *resource, coap_request_t method, coap_method_handler_t handler)
Registers the specified handler as message handler for the request type method.
Definition: resource.c:677
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
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
void(* coap_resource_release_userdata_handler_t)(void *user_data)
Definition of release resource user_data callback function.
Definition: resource.h:212
void coap_add_resource(coap_context_t *context, coap_resource_t *resource)
Registers the given resource for context.
Definition: resource.c:536
coap_resource_t * coap_resource_init(coap_str_const_t *uri_path, int flags)
Creates a new resource object and initializes the link field to the string uri_path.
Definition: resource.c:303
void coap_resource_set_userdata(coap_resource_t *resource, void *data)
Sets the user_data.
Definition: resource.c:1034
coap_str_const_t * coap_resource_get_uri_path(coap_resource_t *resource)
Get the uri_path from a resource.
Definition: resource.c:1055
coap_str_const_t * coap_attr_get_value(coap_attr_t *attribute)
Returns attribute's value.
Definition: resource.c:461
int coap_delete_resource(coap_context_t *context, coap_resource_t *resource)
Deletes a resource identified by resource.
Definition: resource.c:565
coap_attr_t * coap_find_attr(coap_resource_t *resource, coap_str_const_t *name)
Returns resource's coap_attr_t object with given name if found, NULL otherwise.
Definition: resource.c:444
void * coap_resource_get_userdata(coap_resource_t *resource)
Gets the user_data.
Definition: resource.c:1039
coap_resource_t * coap_resource_unknown_init(coap_method_handler_t put_handler)
Creates a new resource object for the unknown resource handler with support for PUT.
Definition: resource.c:337
coap_request_t
CoAP PDU Request methods.
Definition: pdu.h:66
#define COAP_DEPRECATED
Definition: libcoap.h:48
Pre-defined constants that reflect defaults for CoAP.
COAP_DEPRECATED int coap_resource_set_dirty(coap_resource_t *r, const coap_string_t *query)
Definition: resource.c:988
Abstraction of attribute associated with a resource.
The CoAP stack's global state is stored in a coap_context_t object.
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Abstraction of resource that can be attached to coap_context_t.
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
CoAP string data definition with const data.
Definition: str.h:40
CoAP string data definition.
Definition: str.h:32
Defines the application visible subscribe information.