README
¶
Storage Modules
The logic for storing cached files in nedomi is highly modular. At the moment we have a built in storage on disk. But you can have as many and as different as you want. They are all subpackages in the storage/ directory.
Contents
Anatomy of a Storage Module
It is a subpackage in the storage/ directory. It follows the follwing rules:
-
Has a
func New(cfg config.CacheZone, ca types.CacheAlgorithm, logger types.Logger) *Tfunction. -
Tmust conform to the Storage interface which is defined in storage/interface.go
How to Write Your Own Module?
You can add your module by creating a directory with a subpackage in the storage/ directory.
- Go into the
storage/directory with$ cd .../nedomi/storage - Create a directory for your module. The name of the directory will be name of the module. Lets say you want to create a redis module.
mkdir redis - Write your implementation of Storage in this directory as
package redis - In the main nedomi directory run
cd .../nedomi && go generate ./...
Removing a Module
Lets say you want to remove the redis module.
cd .../nedomi/cacherm -rf rediscd .. && go generate ./...
You can remove any storage module as well. Including the built in modules. Just make sure there is at least one left. Otherwise you wouldn't be able to start the server after compiling. The source will compile happily without any modules left, though.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetExpirationHandler ¶
GetExpirationHandler returns a potentially long-lived callback that removes the specified object from the storage.
Types ¶
type Scheduler ¶
type Scheduler struct {
types.SyncLogger
// contains filtered or unexported fields
}
Scheduler efficiently manages and executes callbacks at specified times.
func NewScheduler ¶
NewScheduler initializes and returns a newly created Scheduler instance.
func (*Scheduler) AddEvent ¶
func (em *Scheduler) AddEvent(key types.ObjectIDHash, callback types.ScheduledCallback, expire time.Duration)
AddEvent schedules the passed callback to be executed at the supplied time.
Source Files
Directories