gormstore

Documentation

Index

• type Options
• type Store
  • func New(db *gorm.DB, keyPairs ...[]byte) *Store
  • func NewOptions(db *gorm.DB, opts Options, keyPairs ...[]byte) *Store
  • func (st *Store) Cleanup()
  • func (st *Store) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (st *Store) MaxAge(age int)
  • func (st *Store) MaxLength(l int)
  • func (st *Store) New(r *http.Request, name string) (*sessions.Session, error)
  • func (st *Store) PeriodicCleanup(interval time.Duration, quit <-chan struct{})
  • func (st *Store) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Types

type Options

type Options struct {
	TableName       string
	SkipCreateTable bool
}

Options for gormstore

type Store

type Store struct {
	Codecs      []securecookie.Codec
	SessionOpts *sessions.Options
	// contains filtered or unexported fields
}

Store represent a gormstore

func New

func New(db *gorm.DB, keyPairs ...[]byte) *Store

New creates a new gormstore session

func NewOptions

func NewOptions(db *gorm.DB, opts Options, keyPairs ...[]byte) *Store

NewOptions creates a new gormstore session with options

func (*Store) Cleanup

func (st *Store) Cleanup()

Cleanup deletes expired sessions

func (*Store) Get

func (st *Store) Get(r *http.Request, name string) (*sessions.Session, error)

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

func (*Store) MaxAge

func (st *Store) MaxAge(age int)

MaxAge sets the maximum age for the store and the underlying c01_cookie implementation. Individual sessions can be deleted by setting Options.MaxAge = -1 for that session.

func (*Store) MaxLength

func (st *Store) 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 is 4096 (default for securecookie)

func (*Store) New

func (st *Store) New(r *http.Request, name string) (*sessions.Session, error)

New creates a session with name without adding it to the registry.

func (*Store) PeriodicCleanup

func (st *Store) PeriodicCleanup(interval time.Duration, quit <-chan struct{})

PeriodicCleanup runs Cleanup every interval. Close quit channel to stop.

func (*Store) Save

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

Save session and set c01_cookie header