redis

Documentation

Index

• func GetRedisStore(s Store) (err error, rediStore *redistore.RediStore)
• func SetKeyPrefix(s Store, prefix string) error
• type Store
  • func NewRediStoreWithClient(client *redis.Client, keyPairs ...[]byte) (Store, error)
  • func NewStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)
  • func NewStoreWithDB(poolSize int, network, address, password string, db int, keyPairs ...[]byte) (Store, error)

Functions

func GetRedisStore

func GetRedisStore(s Store) (err error, rediStore *redistore.RediStore)

GetRedisStore get the actual working store.

func SetKeyPrefix

func SetKeyPrefix(s Store, prefix string) error

SetKeyPrefix sets the key prefix in the redis database.

Types

type Store

type Store interface {
	sessions.Store
}

func NewRediStoreWithClient

func NewRediStoreWithClient(client *redis.Client, keyPairs ...[]byte) (Store, error)

NewRediStoreWithClient instantiates a RediStore with a *redis.Client passed in.

func NewStore

func NewStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)

NewStore returns a redis store instance. size: maximum number of idle connections. network: tcp or udp address: host:port password: redis-password Keys are defined in pairs to allow key rotation, but the common case is to set a single authentication key and optionally an encryption key.

The first key in a pair is used for authentication and the second for encryption. The encryption key can be set to nil or omitted in the last pair, but the authentication key is required in all pairs.

It is recommended to use an authentication key with 32 or 64 bytes. The encryption key, if set, must be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256 modes.

func NewStoreWithDB

func NewStoreWithDB(poolSize int, network, address, password string, db int, keyPairs ...[]byte) (Store, error)

NewStoreWithDB - like NewStore but accepts `DB` parameter to select redis DB instead of using the default one ("0")