libwebsockets
Lightweight C library for HTML5 websockets
Loading...
Searching...
No Matches
lws_cache_creation_info Struct Reference

#include <lws-cache-ttl.h>

Collaboration diagram for lws_cache_creation_info:

Data Structures

union  [union].u

Data Fields

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  u
size_t max_footprint
size_t max_items
size_t max_payload
int tsi

Detailed Description

Definition at line 259 of file lws-cache-ttl.h.

Field Documentation

◆ cx

struct lws_context* lws_cache_creation_info::cx

Mandatory: the lws_context

Definition at line 260 of file lws-cache-ttl.h.

◆ name

const char* lws_cache_creation_info::name

Mandatory: short cache name

Definition at line 262 of file lws-cache-ttl.h.

◆ cb

lws_cache_item_destroy_cb lws_cache_creation_info::cb

NULL, or a callback that can hook cache item destory. It is called with the cache lock held, so it must not call cache or sul apis or take other locks

Definition at line 264 of file lws-cache-ttl.h.

◆ parent

struct lws_cache_ttl_lru* lws_cache_creation_info::parent

NULL, or next cache level

Definition at line 268 of file lws-cache-ttl.h.

◆ ops

const struct lws_cache_ops* lws_cache_creation_info::ops

NULL for default, heap-based ops, else custom cache storage and query implementation

Definition at line 270 of file lws-cache-ttl.h.

◆ u

union lws_cache_creation_info::[union].u lws_cache_creation_info::u

these are extra configuration for specific cache types

◆ max_footprint

size_t lws_cache_creation_info::max_footprint

0, or the max heap allocation allowed before destroying lru items to keep it under the limit

Definition at line 286 of file lws-cache-ttl.h.

◆ max_items

size_t lws_cache_creation_info::max_items

0, or the max number of items allowed in the cache before destroying lru items to keep it under the limit

Definition at line 289 of file lws-cache-ttl.h.

◆ max_payload

size_t lws_cache_creation_info::max_payload

0, or the max allowed payload size for one item. For lws_cache_ops_nscookiejar, max_footprint (bytes), max_items (lines) and max_payload (line length) of 0 mean the jar's own defaults (1MiB, 3000, 8192) rather than no limit, and a host may have at most 50 lines: the jar is rewritten on the event loop for each change, so it must stay bounded. The oldest lines go first.

Definition at line 292 of file lws-cache-ttl.h.

◆ tsi

int lws_cache_creation_info::tsi

0 unless using SMP, then tsi to bind sul to

Definition at line 299 of file lws-cache-ttl.h.


The documentation for this struct was generated from the following file: