session

Documentation

Index

• type Listener
• type MemStore
  • func New() *MemStore
  • func NewWithCleanupInterval(cleanupInterval time.Duration) *MemStore
  • func (m *MemStore) Commit(token string, b []byte, expiry time.Time) error
  • func (m *MemStore) Delete(token string) error
  • func (m *MemStore) Find(token string) ([]byte, bool, error)
  • func (m *MemStore) RegisterListener(listener Listener)
  • func (m *MemStore) StopCleanup()

Types

type Listener

type Listener interface {
	Added(token string)
	Removed(token string)
}

type MemStore

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

MemStore represents the session store.

func New

func New() *MemStore

New returns a new MemStore instance, with a background cleanup goroutine that runs every minute to remove expired session data.

func NewWithCleanupInterval

func NewWithCleanupInterval(cleanupInterval time.Duration) *MemStore

NewWithCleanupInterval returns a new MemStore instance. The cleanupInterval parameter controls how frequently expired session data is removed by the background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine from running (i.e. expired sessions will not be removed).

func (*MemStore) Commit

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

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

func (*MemStore) Delete

func (m *MemStore) Delete(token string) error

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

func (*MemStore) Find

func (m *MemStore) Find(token string) ([]byte, bool, error)

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

func (*MemStore) RegisterListener

func (m *MemStore) RegisterListener(listener Listener)

func (*MemStore) StopCleanup

func (m *MemStore) StopCleanup()

StopCleanup terminates the background cleanup goroutine for the MemStore instance. It's rare to terminate this; generally MemStore instances and their cleanup goroutines are intended to be long-lived and run for the lifetime of your application.

There may be occasions though when your use of the MemStore is transient. An example is creating a new MemStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the MemStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.