redis

Documentation

Index

• func GetRedisStore(s Store) (err error, rediStore *redistore.RediStore)
• func SetKeyPrefix(s Store, prefix string) error
• func SetMaxAge(s Store, maxAge int) error
• type Store
  • func NewStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)
  • func NewStoreWithDB(size int, network, address, password, DB string, keyPairs ...[]byte) (Store, error)
  • func NewStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (Store, error)

Functions

func GetRedisStore

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

GetRedisStore get the actual woking store. Ref: https://godoc.org/github.com/boj/redistore#RediStore

func SetKeyPrefix

func SetKeyPrefix(s Store, prefix string) error

SetKeyPrefix sets the key prefix in the redis database.

func SetMaxAge

func SetMaxAge(s Store, maxAge int) error

SetMaxAge set the max age for the store.

Types

type Store

type Store interface {
	sessions.Store
}

func NewStore

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

NewStore 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(size int, network, address, password, DB string, keyPairs ...[]byte) (Store, error)

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

Ref: https://godoc.org/github.com/boj/redistore#NewRediStoreWithDB

func NewStoreWithPool

func NewStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (Store, error)

NewStoreWithPool instantiates a RediStore with a *redis.Pool passed in.

Ref: https://godoc.org/github.com/boj/redistore#NewRediStoreWithPool