README
¶
cacheapi
An alternative BigCache HTTP Server
Web API document
https://johejo.github.io/cacheapi/rest/index.html
Installing
go get -u github.com/johejo/cacheapi/cmd/cacheapi
CLI
Usage of cacheapi
-clearWindow duration
Interval between removing expired entries (clean up).
-hardMaxCacheSize int
HardMaxCacheSize is a limit for cache size in MB. Cache will not allocate more memory than this limit.
-host string
The hostname to listen on.
-lifeWindow duration
Time after which entry can be evicted. (default 10m0s)
-maxEntrySize int
Max size of entry in bytes. (default 500)
-maxInWindow int
Max number of entries in life window. (default 600000)
-port int
The port to listen on. (default 8888)
-shards int
Number of cache shards, value must be a power of two. (default 1024)
-verbose
Verbose mode prints information about new memory allocation.
-version
Print server version.
Docker Image
docker run --rm -d -p 8888:8888 johejo/cacheapi
License
MIT
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CacheHandler ¶
type CacheHandler interface {
PutItem(w http.ResponseWriter, r *http.Request)
PutItemWithKey(w http.ResponseWriter, r *http.Request)
GetItem(w http.ResponseWriter, r *http.Request)
DeleteItem(w http.ResponseWriter, r *http.Request)
ListItem(w http.ResponseWriter, r *http.Request)
GetStats(w http.ResponseWriter, r *http.Request)
GetStatus(w http.ResponseWriter, r *http.Request)
}
CacheHandler combines several methods those implement http.Handler.
func NewCacheHandler ¶
func NewCacheHandler(cs CacheService) CacheHandler
NewCacheHandler returns a new CacheHandler.
type CacheService ¶
type CacheService interface {
Set(key string, v []byte) error
SetAndGenerateUUID(v []byte) (string, error)
Get(key string) (Item, error)
Delete(key string) error
List() ([]Item, error)
Stats() bigcache.Stats
Len() int
Capacity() int
}
CacheService provides function for cache.
func NewCacheService ¶
func NewCacheService(config bigcache.Config) CacheService
NewCacheService returns a new CacheService.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.