session

Documentation

Index

• Variables
• type Keeper
  • func NewKeeper(store Store, offloadAfter time.Duration) *Keeper
  • func (k *Keeper) Destroy(key Key) error
  • func (k *Keeper) GC(ctx context.Context)
  • func (k *Keeper) Get(key Key) (any, error)
  • func (k *Keeper) Keep(value any) (Key, error)
• type Key
• type Session
• type Store

Variables

var NotFound = errors.New("key not found in store")

Types

type Keeper

type Keeper struct {
	sync.Mutex
	list.List
	Store
	// contains filtered or unexported fields
}

func NewKeeper

func NewKeeper(store Store, offloadAfter time.Duration) *Keeper

func (*Keeper) Destroy

func (k *Keeper) Destroy(key Key) error

func (*Keeper) GC

func (k *Keeper) GC(ctx context.Context)

func (*Keeper) Get

func (k *Keeper) Get(key Key) (any, error)

func (*Keeper) Keep

func (k *Keeper) Keep(value any) (Key, error)

type Key

type Key string

type Session

type Session struct {
	Key   Key
	Value any
	// contains filtered or unexported fields
}

type Store

type Store interface {
	Retrieve(Key) (any, error)

	// Store a new session
	Put(Session) error

	// Remove session
	Erase(Key) error

	// Refresh the expire of these sessions
	UpdateExpiration(...Session) error

	// Remove stale sessions
	CollectExpired() error
}

Store represent the long time storage backing for sessions