coap_resource_internal.h

Go to the documentation of this file.

/*
 * coap_resource_internal.h -- generic resource handling
 *
 * Copyright (C) 2010,2011,2014-2026 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 "coap_threadsafe_internal.h"
#include "coap_uthash_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if COAP_SERVER_SUPPORT
#ifndef COAP_RESOURCE_MAX_SUBSCRIBER
#define COAP_RESOURCE_MAX_SUBSCRIBER 0
#endif /* COAP_RESOURCE_MAX_SUBSCRIBER */
 
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;   
  unsigned int is_reverse_proxy:1; 
  unsigned int list_being_traversed:1; 
  unsigned int is_dynamic:1;     
  uint32_t ref;                  
  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;
#if COAP_THREAD_SAFE
  coap_lock_t lock;
#endif /* COAP_THREAD_SAFE */
 
};
 
typedef enum coap_deleting_resource_t {
  COAP_DELETING_RESOURCE,
  COAP_NOT_DELETING_RESOURCE,
  COAP_DELETING_RESOURCE_ON_EXIT
} coap_deleting_resource_t;
 
void coap_add_resource_lkd(coap_context_t *context, coap_resource_t *resource);
 
int coap_delete_resource_lkd(coap_resource_t *resource);
 
COAP_STATIC_INLINE int
coap_resource_release_lkd(coap_resource_t *resource) {
  return coap_delete_resource_lkd(resource);
}
 
 
void coap_delete_all_resources(coap_context_t *context);
 
void coap_resource_reference_lkd(coap_resource_t *resource);
 
#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 RESOURCE_ITER_SAFE(e, el, rtmp) \
  for ((el) = (e); (el) && ((rtmp) = (el)->hh.next, 1); (el) = (rtmp))
 
#define RESOURCES_FIND(r, k, res) {                     \
    HASH_FIND(hh, (r), (k)->s, (k)->length, (res)); \
  }
 
coap_resource_t *coap_get_resource_from_uri_path_lkd(coap_context_t *context,
                                                     coap_str_const_t *uri_path);
 
void coap_delete_attr(coap_attr_t *attr);
 
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);
 
#endif /* COAP_SERVER_SUPPORT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_RESOURCE_INTERNAL_H_ */