coap_resource.h

Go to the documentation of this file.

/*
 * coap_resource.h -- generic resource handling
 *
 * Copyright (C) 2010,2011,2014-2025 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_H_
#define COAP_RESOURCE_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef COAP_RESOURCE_CHECK_TIME
#define COAP_RESOURCE_CHECK_TIME 2
#endif /* COAP_RESOURCE_CHECK_TIME */
 
typedef void (*coap_method_handler_t)(coap_resource_t *resource,
                                      coap_session_t *session,
                                      const coap_pdu_t *request,
                                      const coap_string_t *query,
                                      coap_pdu_t *response);
 
#define COAP_ATTR_FLAGS_RELEASE_NAME  0x1
#define COAP_ATTR_FLAGS_RELEASE_VALUE 0x2
 
#define COAP_RESOURCE_FLAGS_RELEASE_URI 0x1
 
#define COAP_RESOURCE_FLAGS_NOTIFY_NON  0x0
 
#define COAP_RESOURCE_FLAGS_NOTIFY_CON  0x2
 
#define COAP_RESOURCE_FLAGS_NOTIFY_NON_ALWAYS  0x4
 
#define COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT 0x8
 
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_DELAYS 0x10
 
#define COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_05 0x20
 
#define COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_XX 0x40
 
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_4_XX 0x80
 
#define COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_5_XX 0x100
 
#define COAP_RESOURCE_FLAGS_MCAST_LIST \
  (COAP_RESOURCE_FLAGS_HAS_MCAST_SUPPORT | \
   COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_DELAYS | \
   COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_05 | \
   COAP_RESOURCE_FLAGS_LIB_ENA_MCAST_SUPPRESS_2_XX | \
   COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_4_XX | \
   COAP_RESOURCE_FLAGS_LIB_DIS_MCAST_SUPPRESS_5_XX)
 
#define COAP_RESOURCE_FLAGS_FORCE_SINGLE_BODY 0x200
 
#define COAP_RESOURCE_FLAGS_OSCORE_ONLY 0x400
 
#define COAP_RESOURCE_HANDLE_WELLKNOWN_CORE 0x800
 
coap_resource_t *coap_resource_init(coap_str_const_t *uri_path,
                                    int flags);
 
coap_resource_t *coap_resource_unknown_init(coap_method_handler_t put_handler);
 
coap_resource_t *coap_resource_unknown_init2(coap_method_handler_t put_handler,
                                             int flags);
 
coap_resource_t *coap_resource_proxy_uri_init(coap_method_handler_t handler,
                                              size_t host_name_count, const char *host_name_list[]);
 
coap_resource_t *coap_resource_proxy_uri_init2(coap_method_handler_t handler,
                                               size_t host_name_count,
                                               const char *host_name_list[],
                                               int flags);
 
coap_resource_t *coap_resource_reverse_proxy_init(coap_method_handler_t handler,
                                                  int flags);
 
COAP_API coap_resource_t *coap_get_resource_from_uri_path(coap_context_t *context,
                                                          coap_str_const_t *uri_path);
 
coap_str_const_t *coap_resource_get_uri_path(coap_resource_t *resource);
 
void coap_resource_set_mode(coap_resource_t *resource, int mode);
 
void coap_resource_set_userdata(coap_resource_t *resource, void *data);
 
void *coap_resource_get_userdata(coap_resource_t *resource);
 
typedef void (*coap_resource_release_userdata_handler_t)(void *user_data);
 
void coap_resource_release_userdata_handler(coap_context_t *context,
                                            coap_resource_release_userdata_handler_t callback);
 
COAP_API void coap_add_resource(coap_context_t *context, coap_resource_t *resource);
 
COAP_API int coap_delete_resource(coap_context_t *context, coap_resource_t *resource);
 
void coap_register_handler(coap_resource_t *resource,
                           coap_request_t method,
                           coap_method_handler_t handler);
 
void coap_register_request_handler(coap_resource_t *resource,
                                   coap_request_t method,
                                   coap_method_handler_t handler);
 
coap_attr_t *coap_add_attr(coap_resource_t *resource,
                           coap_str_const_t *name,
                           coap_str_const_t *value,
                           int flags);
 
coap_attr_t *coap_find_attr(coap_resource_t *resource,
                            coap_str_const_t *name);
 
coap_str_const_t *coap_attr_get_value(coap_attr_t *attribute);
 
typedef uint32_t coap_print_status_t;
 
#define COAP_PRINT_STATUS_MASK  0xF0000000UL
#define COAP_PRINT_STATUS_MAX   0x0FFFFFFFUL
#define COAP_PRINT_OUTPUT_LENGTH(v) ((v) & COAP_PRINT_STATUS_MAX)
#define COAP_PRINT_STATUS_ERROR 0x80000000UL
#define COAP_PRINT_STATUS_TRUNC 0x40000000UL
 
coap_print_status_t coap_print_link(const coap_resource_t *resource,
                                    unsigned char *buf,
                                    size_t *len,
                                    size_t *offset);
 
COAP_API coap_print_status_t coap_print_wellknown(coap_context_t *context,
                                                  unsigned char *buf,
                                                  size_t *buflen,
                                                  size_t offset,
                                                  const coap_string_t *query_filter);
 
COAP_DEPRECATED COAP_API int coap_resource_set_dirty(coap_resource_t *r,
                                                     const coap_string_t *query);
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_RESOURCE_H_ */