mantle

Documentation

Index

• Variables
• func CreateMemcacheConnection(Instance interface{}) (pools.Resource, error)
• func CreateRedisConnection(Instance interface{}) (pools.Resource, error)
• type MemConn
  • func (m *MemConn) Close()
• type Memcache
  • func (m *Memcache) Configure(settings PoolSettings)
  • func (m *Memcache) Delete(keys ...interface{}) int
  • func (m *Memcache) Execute(cmd string, args ...interface{}) (interface{}, error)
  • func (m *Memcache) Expire(key string, duration int) bool
  • func (m *Memcache) Get(key string) string
  • func (m *Memcache) GetClient() *MemConn
  • func (m *Memcache) MGet(keys ...interface{}) []string
  • func (m *Memcache) MSet(mapOfKeyVal map[string]interface{}) bool
  • func (m *Memcache) PutClient(c *MemConn)
  • func (m *Memcache) Set(key string, value interface{}) bool
  • func (m *Memcache) SetDefaults()
  • func (m *Memcache) Setex(key string, duration int, val interface{}) bool
• type PoolSettings
• type Redis
  • func (r *Redis) Configure(settings PoolSettings)
  • func (r *Redis) Delete(keys ...interface{}) int
  • func (r *Redis) Execute(cmd string, args ...interface{}) (interface{}, error)
  • func (r *Redis) Expire(key string, duration int) bool
  • func (r *Redis) Get(key string) string
  • func (r *Redis) GetClient() (*RedisConn, error)
  • func (r *Redis) MGet(keys ...interface{}) []string
  • func (r *Redis) MSet(mapOfKeyVal map[string]interface{}) bool
  • func (r *Redis) PutClient(c *RedisConn)
  • func (r *Redis) Set(key string, value interface{}) bool
  • func (r *Redis) SetDefaults()
  • func (r *Redis) Setex(key string, duration int, val interface{}) bool
• type RedisConn
  • func (r *RedisConn) Close()
• type ResourcePool
  • func NewPool(connect dialAndConnect, instance interface{}, settings PoolSettings) *ResourcePool
  • func (rp *ResourcePool) GetConn(to time.Duration) (pools.Resource, error)
  • func (rp *ResourcePool) PutConn(conn pools.Resource)

Variables

var DefaultMemcacheIpAndHost = []string{"localhost:11211"}

var DefaultRedisConfig = []string{"localhost:6379"}

default host:port to connect

var MemcachePoolSize = 10

var RedisPoolSize = 10

default pool size

Functions

func CreateMemcacheConnection

func CreateMemcacheConnection(Instance interface{}) (pools.Resource, error)

func CreateRedisConnection

func CreateRedisConnection(Instance interface{}) (pools.Resource, error)

This method creates a redis connection CreateRedisConnection is passed as a callback to pools Instance:

This is a reference to a struct redis instance
Connect needs some params like db, hostAndPorts
These params are read from this instance rederence

Types

type MemConn

type MemConn struct {
	*memcache.Client
}

func (*MemConn) Close

func (m *MemConn) Close()

type Memcache

type Memcache struct {
	Settings PoolSettings
	// contains filtered or unexported fields
}

func (*Memcache) Configure

func (m *Memcache) Configure(settings PoolSettings)

func (*Memcache) Delete

func (m *Memcache) Delete(keys ...interface{}) int

func (*Memcache) Execute

func (m *Memcache) Execute(cmd string, args ...interface{}) (interface{}, error)

func (*Memcache) Expire

func (m *Memcache) Expire(key string, duration int) bool

func (*Memcache) Get

func (m *Memcache) Get(key string) string

func (*Memcache) GetClient

func (m *Memcache) GetClient() *MemConn

func (*Memcache) MGet

func (m *Memcache) MGet(keys ...interface{}) []string

func (*Memcache) MSet

func (m *Memcache) MSet(mapOfKeyVal map[string]interface{}) bool

func (*Memcache) PutClient

func (m *Memcache) PutClient(c *MemConn)

func (*Memcache) Set

func (m *Memcache) Set(key string, value interface{}) bool

func (*Memcache) SetDefaults

func (m *Memcache) SetDefaults()

func (*Memcache) Setex

func (m *Memcache) Setex(key string, duration int, val interface{}) bool

type PoolSettings

type PoolSettings struct {
	HostAndPorts []string
	Capacity     int
	MaxCapacity  int
	Options      map[string]string
	Timeout      time.Duration
}

This struct has all the generic settings that are required for creating a pool

type Redis

type Redis struct {
	Settings PoolSettings
	// contains filtered or unexported fields
}

func (*Redis) Configure

func (r *Redis) Configure(settings PoolSettings)

func (*Redis) Delete

func (r *Redis) Delete(keys ...interface{}) int

func (*Redis) Execute

func (r *Redis) Execute(cmd string, args ...interface{}) (interface{}, error)

Generic method to execute any redis call Gets a client from pool, executes a cmd, puts conn back in pool

func (*Redis) Expire

func (r *Redis) Expire(key string, duration int) bool

func (*Redis) Get

func (r *Redis) Get(key string) string

func (*Redis) GetClient

func (r *Redis) GetClient() (*RedisConn, error)

Gets a connection from pool and converts to RedisConn type If all the connections are in use, timeout the present request after a minute

func (*Redis) MGet

func (r *Redis) MGet(keys ...interface{}) []string

func (*Redis) MSet

func (r *Redis) MSet(mapOfKeyVal map[string]interface{}) bool

func (*Redis) PutClient

func (r *Redis) PutClient(c *RedisConn)

Puts a connection back to pool

func (*Redis) Set

func (r *Redis) Set(key string, value interface{}) bool

func (*Redis) SetDefaults

func (r *Redis) SetDefaults()

Add default settings if they are missing

func (*Redis) Setex

func (r *Redis) Setex(key string, duration int, val interface{}) bool

type RedisConn

type RedisConn struct {
	redis.Conn
}

Wrapping redigo redis connection

Pool expects a Object which defines
Close() and doesn't return anything, but
redigo.Redis#Close() returns error, hence this wrapper
around redis.Conn

func (*RedisConn) Close

func (r *RedisConn) Close()

Close a redis connection

type ResourcePool

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

Wraps pool

func NewPool

func NewPool(connect dialAndConnect, instance interface{}, settings PoolSettings) *ResourcePool

• Creats an instance of pool Params: connect: A callback which creates a connection to datastore instace: An instance of backend(redis instance) settings: configurations needed to create a pool

func (*ResourcePool) GetConn

func (rp *ResourcePool) GetConn(to time.Duration) (pools.Resource, error)

Gets a connection from pool

func (*ResourcePool) PutConn

func (rp *ResourcePool) PutConn(conn pools.Resource)

Puts a connection back in pool