coap_subscribe_internal.h

Go to the documentation of this file.

/*
 * coap_subscribe_internal.h -- Structures, Enums & Functions that are not
 * exposed to application programming
 *
 * Copyright (C) 2010-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_SUBSCRIBE_INTERNAL_H_
#define COAP_SUBSCRIBE_INTERNAL_H_
 
#ifdef __cplusplus
extern "C" {
#endif

 
#if COAP_SERVER_SUPPORT
#ifndef COAP_OBS_MAX_NON
#define COAP_OBS_MAX_NON   5
#endif /* COAP_OBS_MAX_NON */
#if COAP_OBS_MAX_NON > 255
#error COAP_OBS_MAX_NON is too large
#endif /* COAP_OBS_MAX_NON > 255 */

#ifndef COAP_OBS_MAX_FAIL
#define COAP_OBS_MAX_FAIL  1
#endif /* COAP_OBS_MAX_FAIL */
#if COAP_OBS_MAX_FAIL > 255
#error COAP_OBS_MAX_FAIL is too large
#endif /* COAP_OBS_MAX_FAIL > 255 */

struct coap_subscription_t {
  struct coap_subscription_t *next; 
  struct coap_session_t *session;   
  coap_address_t local_if;         
 
  uint8_t non_cnt;  
  uint8_t fail_cnt; 
  uint8_t dirty;    
  uint8_t to_visit; 
  coap_cache_key_t *cache_key; 
  coap_pdu_t *pdu;         
};
 
void coap_subscription_init(coap_subscription_t *);

void coap_handle_failed_notify(coap_context_t *context,
                               coap_session_t *session,
                               const coap_bin_const_t *token);

coap_subscription_t *coap_add_observer(coap_resource_t *resource,
                                       coap_session_t *session,
                                       const coap_bin_const_t *token,
                                       const coap_pdu_t *pdu);

coap_subscription_t *coap_find_observer(coap_resource_t *resource,
                                        coap_session_t *session,
                                        const coap_bin_const_t *token);

void coap_touch_observer(coap_context_t *context,
                         coap_session_t *session,
                         const coap_bin_const_t *token);

int coap_delete_observer(coap_resource_t *resource,
                         coap_session_t *session,
                         const coap_bin_const_t *token);

int coap_delete_observer_request(coap_resource_t *resource,
                                 coap_session_t *session,
                                 const coap_bin_const_t *token,
                                 coap_pdu_t *request,
                                 int large_fetch);

void coap_delete_observers(coap_context_t *context, coap_session_t *session);

void coap_delete_observer_internal(coap_resource_t *resource,
                                   coap_session_t *session,
                                   coap_subscription_t *subscription);

int coap_resource_notify_observers_lkd(coap_resource_t *resource,
                                       coap_deleting_resource_t deleting);

void coap_check_notify_lkd(coap_context_t *context);

void coap_persist_cleanup(coap_context_t *context);

coap_subscription_t *coap_persist_observe_add_lkd(coap_context_t *context,
                                                  coap_proto_t e_proto,
                                                  const coap_address_t *e_listen_addr,
                                                  const coap_addr_tuple_t *s_addr_info,
                                                  const coap_bin_const_t *raw_packet,
                                                  const coap_bin_const_t *oscore_info);

int coap_persist_startup_lkd(coap_context_t *context,
                             const char *dyn_resource_save_file,
                             const char *observe_save_file,
                             const char *obs_cnt_save_file,
                             uint32_t save_freq);

void coap_persist_stop_lkd(coap_context_t *context);
 
#endif /* COAP_SERVER_SUPPORT */
 
#if COAP_CLIENT_SUPPORT

int coap_cancel_observe_lkd(coap_session_t *session, coap_binary_t *token,
                            coap_pdu_type_t message_type);
 
#endif /* COAP_CLIENT_SUPPORT */

 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_SUBSCRIBE_INTERNAL_H_ */