Nebulex v1.2.0 API Reference
Modules
Nebulex is split into 2 main components
This module specifies the adapter API that a Cache adapter is required to implement.
This behaviour provides a callback to compute the hash slot for a specific key based on the number of slots/nodes.
Specifies the adapter persistence API.
Specifies the query API required from adapters.
Specifies the adapter transactions API.
Adapter module for Local Generational Cache.
Generations Handler. This GenServer acts as garbage collector, everytime it runs, a new cache generation is created a the oldest one is deleted.
Adapter module for Multi-level Cache.
Built-in adapter for partitioned cache topology.
Built-in adapter for replicated cache topology.
Cache Main Interface.
Function decorators which provide a way of annotating functions to be cached or evicted. By means of these decorators, it is possible the implementation of cache usage patterns like Read-through, Write-through, Cache-as-SoR, etc.
This module specifies the behaviour for pre/post hooks callbacks. These functions are defined in order to intercept any cache operation and be able to execute a set of actions before and/or after the operation takes place.
Raised at runtime when a key already exists in cache.
Defines a Cache Object.
Version handler for cached objects.
Raised at runtime when the query is invalid.
RPC utilities for distributed task execution.
Raised at runtime when a RPC multi_call error occurs.
Raised at runtime when there is a version conflict between the required object version and the cached object version.
Mix Tasks
Prints Nebulex tasks and their information.
Generates a new cache.