memcached

Documentation

Index

• Constants
• type Config
  • func (s *Config) InitDefaults()
• type Driver
  • func NewMemcachedDriver(log logger.Logger, key string, cfgPlugin config.Configurer) (*Driver, error)
  • func (d *Driver) Clear() error
  • func (d *Driver) Delete(keys ...string) error
  • func (d *Driver) Get(key string) ([]byte, error)
  • func (d *Driver) Has(keys ...string) (map[string]bool, error)
  • func (d *Driver) MExpire(items ...*kvv1.Item) error
  • func (d *Driver) MGet(keys ...string) (map[string][]byte, error)
  • func (d *Driver) Set(items ...*kvv1.Item) error
  • func (d *Driver) TTL(_ ...string) (map[string]string, error)
• type Plugin
  • func (s *Plugin) Available()
  • func (s *Plugin) Init(log logger.Logger, cfg config.Configurer) error
  • func (s *Plugin) KVConstruct(key string) (kv.Storage, error)
  • func (s *Plugin) Name() string

Constants

const (
	PluginName     string = "memcached"
	RootPluginName string = "kv"
)

Types

type Config

type Config struct {
	// Addr is url for memcached, 11211 port is used by default
	Addr []string
}

func (*Config) InitDefaults

func (s *Config) InitDefaults()

type Driver

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

func NewMemcachedDriver

func NewMemcachedDriver(log logger.Logger, key string, cfgPlugin config.Configurer) (*Driver, error)

NewMemcachedDriver returns a memcache client using the provided server(s) with equal weight. If a server is listed multiple times, it gets a proportional amount of weight.

func (*Driver) Clear

func (d *Driver) Clear() error

func (*Driver) Delete

func (d *Driver) Delete(keys ...string) error

func (*Driver) Get

func (d *Driver) Get(key string) ([]byte, error)

Get gets the item for the given key. ErrCacheMiss is returned for a memcache cache miss. The key must be at most 250 bytes in length.

func (*Driver) Has

func (d *Driver) Has(keys ...string) (map[string]bool, error)

Has checks the key for existence

func (*Driver) MExpire

func (d *Driver) MExpire(items ...*kvv1.Item) error

MExpire Expiration is the cache expiration time, in seconds: either a relative time from now (up to 1 month), or an absolute Unix epoch time. Zero means the Item has no expiration time.

func (*Driver) MGet

func (d *Driver) MGet(keys ...string) (map[string][]byte, error)

MGet return map with key -- string and map value as value -- []byte

func (*Driver) Set

func (d *Driver) Set(items ...*kvv1.Item) error

Set sets the KV pairs. Keys should be 250 bytes maximum TTL: Expiration is the cache expiration time, in seconds: either a relative time from now (up to 1 month), or an absolute Unix epoch time. Zero means the Item has no expiration time.

func (*Driver) TTL

func (d *Driver) TTL(_ ...string) (map[string]string, error)

TTL return time in seconds (int32) for a given keys

type Plugin

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

func (*Plugin) Available

func (s *Plugin) Available()

Available interface implementation

func (*Plugin) Init

func (s *Plugin) Init(log logger.Logger, cfg config.Configurer) error

func (*Plugin) KVConstruct

func (s *Plugin) KVConstruct(key string) (kv.Storage, error)

func (*Plugin) Name

func (s *Plugin) Name() string

Name returns plugin user-friendly name