coap_cache.h

Go to the documentation of this file.

/* coap_cache.h -- Caching of CoAP requests
*
* Copyright (C) 2020-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_CACHE_H_
#define COAP_CACHE_H_
 
#ifdef __cplusplus
extern "C" {
#endif


typedef void (*coap_cache_app_data_free_callback_t)(void *data);
 
typedef enum coap_cache_session_based_t {
  COAP_CACHE_NOT_SESSION_BASED,
  COAP_CACHE_IS_SESSION_BASED,
  COAP_CACHE_IS_SESSION_BASED_NO_DATA
} coap_cache_session_based_t;
 
typedef enum coap_cache_record_pdu_t {
  COAP_CACHE_NOT_RECORD_PDU,
  COAP_CACHE_RECORD_PDU
} coap_cache_record_pdu_t;

coap_cache_key_t *coap_cache_derive_key(const coap_session_t *session,
                                        const coap_pdu_t *pdu,
                                        coap_cache_session_based_t session_based);

coap_cache_key_t *coap_cache_derive_key_w_ignore(const coap_session_t *session,
                                                 const coap_pdu_t *pdu,
                                                 coap_cache_session_based_t session_based,
                                                 const uint16_t *ignore_options,
                                                 size_t ignore_count);

void coap_delete_cache_key(coap_cache_key_t *cache_key);

COAP_API int coap_cache_ignore_options(coap_context_t *context,
                                       const uint16_t *options, size_t count);

COAP_API coap_cache_entry_t *coap_new_cache_entry(coap_session_t *session,
                                                  const coap_pdu_t *pdu,
                                                  coap_cache_record_pdu_t record_pdu,
                                                  coap_cache_session_based_t session_based,
                                                  unsigned int idle_time);

void coap_delete_cache_entry(coap_context_t *context,
                             coap_cache_entry_t *cache_entry);

COAP_API coap_cache_entry_t *coap_cache_get_by_key(coap_context_t *context,
                                                   const coap_cache_key_t *cache_key);

COAP_API coap_cache_entry_t *coap_cache_get_by_pdu(coap_session_t *session,
                                                   const coap_pdu_t *pdu,
                                                   coap_cache_session_based_t session_based);

const coap_pdu_t *coap_cache_get_pdu(const coap_cache_entry_t *cache_entry);

COAP_DEPRECATED void coap_cache_set_app_data(coap_cache_entry_t *cache_entry,
                                             void *data,
                                             coap_app_data_free_callback_t callback);

COAP_API void *coap_cache_set_app_data2(coap_cache_entry_t *cache_entry,
                                        void *data,
                                        coap_app_data_free_callback_t callback);

void *coap_cache_get_app_data(const coap_cache_entry_t *cache_entry);

 
#ifdef __cplusplus
}
#endif
 
#endif  /* COAP_CACHE_H */