nats

Documentation

Index

• func Factory(natsConfiguration core.CacheProvider, logger core.Logger, stale time.Duration) (core.Storer, error)
• type Nats
  • func (provider *Nats) Delete(key string)
  • func (provider *Nats) DeleteMany(key string)
  • func (provider *Nats) Get(key string) []byte
  • func (provider *Nats) GetMultiLevel(key string, req *http.Request, validator *core.Revalidator) (fresh *http.Response, stale *http.Response)
  • func (provider *Nats) Init() error
  • func (provider *Nats) ListKeys() []string
  • func (provider *Nats) MapKeys(prefix string) map[string]string
  • func (provider *Nats) Name() string
  • func (provider *Nats) Reset() error
  • func (provider *Nats) Set(key string, value []byte, _ time.Duration) error
  • func (provider *Nats) SetMultiLevel(baseKey, variedKey string, value []byte, variedHeaders http.Header, ...) error
  • func (provider *Nats) Uuid() string

Functions

func Factory

func Factory(natsConfiguration core.CacheProvider, logger core.Logger, stale time.Duration) (core.Storer, error)

Factory function create new Nats instance.

Types

type Nats

type Nats struct {
	// contains filtered or unexported fields
}

Nats provider type.

func (*Nats) Delete

func (provider *Nats) Delete(key string)

Delete method will delete the response in Nats provider if exists corresponding to key param.

func (*Nats) DeleteMany

func (provider *Nats) DeleteMany(key string)

DeleteMany method will delete the responses in Nats provider if exists corresponding to the regex key param.

func (*Nats) Get

func (provider *Nats) Get(key string) []byte

Get method returns the populated response if exists, empty response then.

func (*Nats) GetMultiLevel

func (provider *Nats) GetMultiLevel(key string, req *http.Request, validator *core.Revalidator) (fresh *http.Response, stale *http.Response)

GetMultiLevel tries to load the key and check if one of linked keys is a fresh/stale candidate.

func (*Nats) Init

func (provider *Nats) Init() error

Init method will.

func (*Nats) ListKeys

func (provider *Nats) ListKeys() []string

ListKeys method returns the list of existing keys.

func (*Nats) MapKeys

func (provider *Nats) MapKeys(prefix string) map[string]string

MapKeys method returns a map with the key and value.

func (*Nats) Name

func (provider *Nats) Name() string

Name returns the storer name.

func (*Nats) Reset

func (provider *Nats) Reset() error

Reset method will reset or close provider.

func (*Nats) Set

func (provider *Nats) Set(key string, value []byte, _ time.Duration) error

Set method will store the response in Nats provider.

func (*Nats) SetMultiLevel

func (provider *Nats) SetMultiLevel(baseKey, variedKey string, value []byte, variedHeaders http.Header, etag string, duration time.Duration, realKey string) error

SetMultiLevel tries to store the key with the given value and update the mapping key to store metadata.

func (*Nats) Uuid

func (provider *Nats) Uuid() string

Uuid returns an unique identifier.