lws-cache-ttl.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
 
struct lws_cache_ttl_lru;

LWS_VISIBLE LWS_EXTERN void
lws_cache_lock(struct lws_cache_ttl_lru *cache);

LWS_VISIBLE LWS_EXTERN void
lws_cache_unlock(struct lws_cache_ttl_lru *cache);

LWS_VISIBLE LWS_EXTERN int /* only valid until return to event loop */
lws_cache_write_through(struct lws_cache_ttl_lru *cache,
                        const char *specific_key, const uint8_t *source,
                        size_t size, lws_usec_t expiry, void **ppay);
 
typedef struct lws_cache_match {
        lws_dll2_t                      list;
        lws_usec_t                      expiry;
        /* earliest expiry amongst results */
        size_t                          payload_size;
        size_t                          tag_size;
 
        /* tag name + NUL is overcommitted */
} lws_cache_match_t;

LWS_VISIBLE LWS_EXTERN int
lws_cache_lookup(struct lws_cache_ttl_lru *cache, const char *wildcard_key,
                 const void **pdata, size_t *psize);

LWS_VISIBLE LWS_EXTERN int
lws_cache_item_get(struct lws_cache_ttl_lru *cache, const char *specific_key,
                   const void **pdata, size_t *psize);

LWS_VISIBLE LWS_EXTERN int
lws_cache_item_remove(struct lws_cache_ttl_lru *cache, const char *specific_key);

LWS_VISIBLE LWS_EXTERN uint64_t
lws_cache_footprint(struct lws_cache_ttl_lru *cache);

LWS_VISIBLE LWS_EXTERN void
lws_cache_debug_dump(struct lws_cache_ttl_lru *cache);
 
typedef struct lws_cache_results {
        const uint8_t           *ptr; /* set before using walk api */
        size_t                  size; /* set before using walk api */
 
        size_t                  payload_len;
        size_t                  tag_len;
        const uint8_t           *tag;
} lws_cache_results_t;

LWS_VISIBLE LWS_EXTERN int
lws_cache_results_walk(lws_cache_results_t *walk_ctx);
 
typedef void (*lws_cache_item_destroy_cb)(void *item, size_t size);
struct lws_cache_creation_info {
        struct lws_context              *cx;
        const char                      *name;
        lws_cache_item_destroy_cb       cb;
        struct lws_cache_ttl_lru        *parent;
        const struct lws_cache_ops      *ops;
 
        union {
                struct {
                        const char      *filepath;
                } nscookiejar;
                struct {
                        const char      *dir;
                } blob;
        } u;

 
        size_t                          max_footprint;
        size_t                          max_items;
        size_t                          max_payload;
        int                             tsi;
};
 
struct lws_cache_ops {
        struct lws_cache_ttl_lru *
        (*create)(const struct lws_cache_creation_info *info);
 
        void
        (*destroy)(struct lws_cache_ttl_lru **_cache);
 
        int
        (*expunge)(struct lws_cache_ttl_lru *cache);
 
        int
        (*write)(struct lws_cache_ttl_lru *cache, const char *specific_key,
                 const uint8_t *source, size_t size, lws_usec_t expiry,
                 void **ppvoid);
        int
        (*tag_match)(struct lws_cache_ttl_lru *cache, const char *wc,
                     const char *tag, char lookup_rules);
        int
        (*lookup)(struct lws_cache_ttl_lru *cache, const char *wildcard_key,
                      lws_dll2_owner_t *results_owner);
        int
        (*invalidate)(struct lws_cache_ttl_lru *cache, const char *specific_key);
 
        int
        (*get)(struct lws_cache_ttl_lru *cache, const char *specific_key,
               const void **pdata, size_t *psize);
 
        void
        (*debug_dump)(struct lws_cache_ttl_lru *cache);
};

LWS_VISIBLE LWS_EXTERN struct lws_cache_ttl_lru *
lws_cache_create(const struct lws_cache_creation_info *info);

LWS_VISIBLE LWS_EXTERN void
lws_cache_destroy(struct lws_cache_ttl_lru **cache);

LWS_VISIBLE LWS_EXTERN int
lws_cache_expunge(struct lws_cache_ttl_lru *cache);
 
LWS_VISIBLE LWS_EXTERN_FOR_DATA const struct lws_cache_ops lws_cache_ops_heap;
LWS_VISIBLE LWS_EXTERN_FOR_DATA const struct lws_cache_ops lws_cache_ops_nscookiejar;
LWS_VISIBLE LWS_EXTERN_FOR_DATA const struct lws_cache_ops lws_cache_ops_blob;