redistore

README

redistore

A session store backend for gorilla/sessions - src.

Requirements

Depends on the Redigo Redis library.

Installation

go get github.com/boj/redistore

Documentation

Available on godoc.org.

See http://www.gorillatoolkit.org/pkg/sessions for full documentation on underlying interface.

Example

// Fetch new store.
store := NewRediStore(10, "tcp", ":6379", "", []byte("secret-key"))
defer store.Close()

// Get a session.
session, err = store.Get(req, "session-key")
if err != nil {
    log.Error(err.Error())
}

// Add a value.
session.Values["foo"] = "bar"

// Save.
if err = sessions.Save(req, rsp); err != nil {
    t.Fatalf("Error saving session: %v", err)
}

// Delete session.
session.Options.MaxAge = -1
if err = sessions.Save(req, rsp); err != nil {
    t.Fatalf("Error saving session: %v", err)
}

Notes

July 18th, 2013

• Delete() should be considered deprecated since it is not exposed via the gorilla/sessions interface. Set session.Options.MaxAge = -1 and call Save instead.

Documentation

Overview

Package redistore is a session store backend for gorilla/sessions

Index

• type RediStore
  • func NewRediStore(size int, network, address, password string, keyPairs ...[]byte) *RediStore
  • func (s *RediStore) Close()
  • func (s *RediStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
  • func (s *RediStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (s *RediStore) MaxLength(l int)
  • func (s *RediStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (s *RediStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Examples

• RediStore

Types

type RediStore

type RediStore struct {
	Pool    *redis.Pool
	Codecs  []securecookie.Codec
	Options *sessions.Options // default configuration
}

RediStore stores sessions in a redis backend.

Example

// RedisStore
store := NewRediStore(10, "tcp", ":6379", "", []byte("secret-key"))
defer store.Close()

func NewRediStore

func NewRediStore(size int, network, address, password string, keyPairs ...[]byte) *RediStore

NewRediStore returns a new RediStore.

func (*RediStore) Close

func (s *RediStore) Close()

Close cleans up the redis connections.

func (*RediStore) Delete

func (s *RediStore) Delete(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Delete removes the session from redis, and sets the cookie to expire.

WARNING: This method should be considered deprecated since it is not exposed via the gorilla/sessions interface. Set session.Options.MaxAge = -1 and call Save instead. - July 18th, 2013

func (*RediStore) Get

func (s *RediStore) Get(r *http.Request, name string) (*sessions.Session, error)

Get returns a session for the given name after adding it to the registry.

See gorilla/sessions FilesystemStore.Get().

func (*RediStore) MaxLength

func (s *RediStore) MaxLength(l int)

MaxLength restricts the maximum length of new sessions to l. If l is 0 there is no limit to the size of a session, use with caution. The default for a new RediStore is 4096. Redis allows for max. value sizes of up to 512MB (http://redis.io/topics/data-types)

func (*RediStore) New

func (s *RediStore) New(r *http.Request, name string) (*sessions.Session, error)

New returns a session for the given name without adding it to the registry.

See gorilla/sessions FilesystemStore.New().

func (*RediStore) Save

func (s *RediStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Save adds a single session to the response.