redisstore

README

scs-redisstore

go-redis based SCS Session store

Documentation

Index

• Variables
• type RedisStore
  • func New(pool redis.Cmdable) *RedisStore
  • func (r *RedisStore) Commit(token string, b []byte, expiry time.Time) error
  • func (r *RedisStore) Delete(token string) error
  • func (r *RedisStore) Find(token string) (b []byte, found bool, err error)

Variables

var Prefix = "scs:session:"

Prefix controls the Redis key prefix. You should only need to change this if there is a naming clash.

Types

type RedisStore

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

RedisStore represents the currently configured session session store. It supports any client that implements redis.Cmdable interface, ex. redis.Client, redis.ClusterClient etc

func New

func New(pool redis.Cmdable) *RedisStore

New returns a new RedisStore instance. The pool parameter should be any redis.Cmdable implementation

func (*RedisStore) Commit

func (r *RedisStore) Commit(token string, b []byte, expiry time.Time) error

Save adds a session token and data to the RedisStore instance with the given expiry time. If the session token already exists then the data and expiry time are updated.

func (*RedisStore) Delete

func (r *RedisStore) Delete(token string) error

Delete removes a session token and corresponding data from the ResisStore instance.

func (*RedisStore) Find

func (r *RedisStore) Find(token string) (b []byte, found bool, err error)

Find returns the data for a given session token from the RedisStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.