coap_cache_internal.h

Go to the documentation of this file.

/*
 * coap_cache_internal.h -- Cache functions for libcoap
 *
 * Copyright (C) 2019--2026 Olaf Bergmann <bergmann@tzi.org> and others
 *
 * 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_INTERNAL_H_
#define COAP_CACHE_INTERNAL_H_
 
#include "coap_uthash_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if COAP_SERVER_SUPPORT
/* Holds a digest in binary typically sha256 except for notls */
typedef struct coap_digest_t {
  uint8_t key[32];
} coap_digest_t;
 
struct coap_cache_key_t {
  uint8_t key[32];
};
 
struct coap_cache_entry_t {
  UT_hash_handle hh;
  coap_cache_key_t *cache_key;
  coap_session_t *session;
  coap_pdu_t *pdu;
  void *app_data;
  coap_tick_t expire_ticks;
  unsigned int idle_timeout;
  coap_app_data_free_callback_t app_cb;
};
 
void coap_expire_cache_entries(coap_context_t *context);
 
coap_cache_entry_t *coap_cache_get_by_key_lkd(coap_context_t *context,
                                              const coap_cache_key_t *cache_key);
 
coap_cache_entry_t *coap_cache_get_by_pdu_lkd(coap_session_t *session,
                                              const coap_pdu_t *pdu,
                                              coap_cache_session_based_t session_based);
 
int coap_cache_ignore_options_lkd(coap_context_t *context,
                                  const uint16_t *options, size_t count);
 
coap_cache_entry_t *coap_new_cache_entry_lkd(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_cache_set_app_data2_lkd(coap_cache_entry_t *cache_entry,
                                   void *data,
                                   coap_app_data_free_callback_t callback);
 
typedef void coap_digest_ctx_t;
 
coap_digest_ctx_t *coap_digest_setup(void);
 
void coap_digest_free(coap_digest_ctx_t *digest_ctx);
 
int coap_digest_update(coap_digest_ctx_t *digest_ctx,
                       const uint8_t *data,
                       size_t data_len
                      );
 
int coap_digest_final(coap_digest_ctx_t *digest_ctx,
                      coap_digest_t *digest_buffer);
 
#endif /* COAP_SERVER_SUPPORT */
 
#ifdef __cplusplus
}
#endif
 
#endif /* COAP_CACHE_INTERNAL_H_ */