libcoap 4.3.2rc2

coap_cache.h
Go to the documentation of this file.
1/* coap_cache.h -- Caching of CoAP requests
2*
3* Copyright (C) 2020-2023 Olaf Bergmann <bergmann@tzi.org>
4*
5 * SPDX-License-Identifier: BSD-2-Clause
6 *
7* This file is part of the CoAP library libcoap. Please see
8* README for terms of use.
9*/
10
16#ifndef COAP_CACHE_H_
17#define COAP_CACHE_H_
18
19#include "coap_forward_decls.h"
20
35 typedef void (*coap_cache_app_data_free_callback_t)(void *data);
36
37 typedef enum coap_cache_session_based_t {
38 COAP_CACHE_NOT_SESSION_BASED,
39 COAP_CACHE_IS_SESSION_BASED
40} coap_cache_session_based_t;
41
42 typedef enum coap_cache_record_pdu_t {
43 COAP_CACHE_NOT_RECORD_PDU,
44 COAP_CACHE_RECORD_PDU
45} coap_cache_record_pdu_t;
46
71 coap_cache_key_t *coap_cache_derive_key(const coap_session_t *session,
72 const coap_pdu_t *pdu,
73 coap_cache_session_based_t session_based);
74
101 coap_cache_key_t *coap_cache_derive_key_w_ignore(const coap_session_t *session,
102 const coap_pdu_t *pdu,
103 coap_cache_session_based_t session_based,
104 const uint16_t *ignore_options,
105 size_t ignore_count);
106
112 void coap_delete_cache_key(coap_cache_key_t *cache_key);
113
126 int coap_cache_ignore_options(coap_context_t *context,
127 const uint16_t *options, size_t count);
128
152 coap_cache_entry_t *coap_new_cache_entry(coap_session_t *session,
153 const coap_pdu_t *pdu,
154 coap_cache_record_pdu_t record_pdu,
155 coap_cache_session_based_t session_based,
156 unsigned int idle_time);
157
165 void coap_delete_cache_entry(coap_context_t *context,
166 coap_cache_entry_t *cache_entry);
167
178 coap_cache_entry_t *coap_cache_get_by_key(coap_context_t *context,
179 const coap_cache_key_t *cache_key);
180
193 coap_cache_entry_t *coap_cache_get_by_pdu(coap_session_t *session,
194 const coap_pdu_t *pdu,
195 coap_cache_session_based_t session_based);
196
205 const coap_pdu_t *coap_cache_get_pdu(const coap_cache_entry_t *cache_entry);
206
218 void coap_cache_set_app_data(coap_cache_entry_t *cache_entry, void *data,
219 coap_cache_app_data_free_callback_t callback);
220
230 void *coap_cache_get_app_data(const coap_cache_entry_t *cache_entry);
231
234#endif /* COAP_CACHE_H */
coap_forward_decls.h
CoAP forward definitions.
coap_delete_cache_entry
void coap_delete_cache_entry(coap_context_t *context, coap_cache_entry_t *cache_entry)
Remove a cache-entry from the hash list and free off all the appropriate contents apart from app_data...
coap_delete_cache_key
void coap_delete_cache_key(coap_cache_key_t *cache_key)
Delete the cache-key.
coap_cache_derive_key
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)
Calculates a cache-key for the given CoAP PDU.
coap_cache_record_pdu_t
coap_cache_record_pdu_t
Definition: coap_cache.h:42
coap_cache_app_data_free_callback_t
void(* coap_cache_app_data_free_callback_t)(void *data)
Callback to free off the app data when the cache-entry is being deleted / freed off.
Definition: coap_cache.h:35
coap_cache_get_pdu
const coap_pdu_t * coap_cache_get_pdu(const coap_cache_entry_t *cache_entry)
Returns the PDU information stored in the coap_cache entry.
coap_cache_get_by_pdu
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)
Searches for a cache-entry corresponding to pdu.
coap_cache_ignore_options
int coap_cache_ignore_options(coap_context_t *context, const uint16_t *options, size_t count)
Define the CoAP options that are not to be included when calculating the cache-key.
coap_cache_derive_key_w_ignore
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)
Calculates a cache-key for the given CoAP PDU.
coap_new_cache_entry
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)
Create a new cache-entry hash keyed by cache-key derived from the PDU.
coap_cache_get_app_data
void * coap_cache_get_app_data(const coap_cache_entry_t *cache_entry)
Returns any application-specific data that has been stored with cache_entry using the function coap_c...
coap_cache_get_by_key
coap_cache_entry_t * coap_cache_get_by_key(coap_context_t *context, const coap_cache_key_t *cache_key)
Searches for a cache-entry identified by cache_key.
coap_cache_set_app_data
void coap_cache_set_app_data(coap_cache_entry_t *cache_entry, void *data, coap_cache_app_data_free_callback_t callback)
Stores data with the given cache entry.
coap_cache_session_based_t
coap_cache_session_based_t
Definition: coap_cache.h:37
COAP_CACHE_RECORD_PDU
@ COAP_CACHE_RECORD_PDU
Definition: coap_cache.h:44
COAP_CACHE_NOT_RECORD_PDU
@ COAP_CACHE_NOT_RECORD_PDU
Definition: coap_cache.h:43
COAP_CACHE_NOT_SESSION_BASED
@ COAP_CACHE_NOT_SESSION_BASED
Definition: coap_cache.h:38
COAP_CACHE_IS_SESSION_BASED
@ COAP_CACHE_IS_SESSION_BASED
Definition: coap_cache.h:39
coap_cache_entry_t
Definition: coap_cache_internal.h:41
coap_cache_key_t
Definition: coap_cache_internal.h:37
coap_context_t
The CoAP stack's global state is stored in a coap_context_t object.
Definition: coap_net_internal.h:49
coap_pdu_t
structure for CoAP PDUs
Definition: coap_pdu_internal.h:119
coap_session_t
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
Definition: coap_session_internal.h:68