libcoap  4.3.0rc1
coap_cache.h
Go to the documentation of this file.
1 /* coap_cache.h -- Caching of CoAP requests
2 *
3 * Copyright (C) 2020 Olaf Bergmann <bergmann@tzi.org>
4 *
5 * This file is part of the CoAP library libcoap. Please see
6 * README for terms of use.
7 */
8 
14 #ifndef COAP_CACHE_H_
15 #define COAP_CACHE_H_
16 
17 #include "coap_forward_decls.h"
18 
31 typedef void (*coap_cache_app_data_free_callback_t)(void *data);
32 
37 
42 
68  const coap_pdu_t *pdu,
69  coap_cache_session_based_t session_based);
70 
77 
91  const uint16_t *options, size_t count);
92 
117  const coap_pdu_t *pdu,
118  coap_cache_record_pdu_t record_pdu,
119  coap_cache_session_based_t session_based,
120  unsigned int idle_time);
121 
130  coap_cache_entry_t *cache_entry);
131 
143  const coap_cache_key_t *cache_key);
144 
158  const coap_pdu_t *pdu,
159  coap_cache_session_based_t session_based);
160 
169 const coap_pdu_t *coap_cache_get_pdu(const coap_cache_entry_t *cache_entry);
170 
182 void coap_cache_set_app_data(coap_cache_entry_t *cache_entry, void *data,
184 
194 void *coap_cache_get_app_data(const coap_cache_entry_t *cache_entry);
195 
198 #endif /* COAP_CACHE_H */
COAP forward definitions.
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...
Definition: coap_cache.c:205
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.
Definition: coap_cache.c:186
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.
Definition: coap_cache.c:223
void coap_delete_cache_key(coap_cache_key_t *cache_key)
Delete the cache-key.
Definition: coap_cache.c:123
coap_cache_record_pdu_t
Definition: coap_cache.h:38
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:31
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.
Definition: coap_cache.c:65
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.
Definition: coap_cache.c:171
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.
Definition: coap_cache.c:39
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.
Definition: coap_cache.c:128
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...
Definition: coap_cache.c:236
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.
Definition: coap_cache.c:228
coap_cache_session_based_t
Definition: coap_cache.h:33
@ COAP_CACHE_RECORD_PDU
Definition: coap_cache.h:40
@ COAP_CACHE_NOT_RECORD_PDU
Definition: coap_cache.h:39
@ COAP_CACHE_NOT_SESSION_BASED
Definition: coap_cache.h:34
@ COAP_CACHE_IS_SESSION_BASED
Definition: coap_cache.h:35
The CoAP stack's global state is stored in a coap_context_t object.
Definition: net.h:150
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Definition: pdu.h:287