session

README

session

HTTP Sessions store agnostic implementation for Go

Documentation

Index

• Constants
• Variables
• func NewMiddleware(manager *Manager) func(http.Handler) http.Handler
• func ToCtx(ctx context.Context, s *Session) context.Context
• type Manager
  • func DefaultManager(store Store) *Manager
  • func NewManager(emptyCookie http.Cookie, ipStrict bool, store Store) *Manager
  • func (m *Manager) Delete(session string) error
  • func (m *Manager) Get(session, key string) (interface{}, error)
  • func (m *Manager) Session(w http.ResponseWriter, r *http.Request) *Session
  • func (m *Manager) Set(session, key string, v interface{}) error
• type Middleware
  • func (m *Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Session
  • func FromCtx(ctx context.Context) (s *Session)
  • func (s *Session) Get(name string) (interface{}, error)
  • func (s *Session) Name() string
  • func (s *Session) Set(name string, value interface{}) error
• type Store

Constants

const DefaultCookieName = "GOSESSION"

const DefaultIPStrict = false

const DefaultTTL = 24 * time.Hour

Variables

var DefaultCookie = http.Cookie{
	Name:   DefaultCookieName,
	MaxAge: int(DefaultTTL.Seconds()),
	Path:   "/",
}

var ErrorEmptyManager = fmt.Errorf("Empty manager")

Functions

func NewMiddleware

func NewMiddleware(manager *Manager) func(http.Handler) http.Handler

func ToCtx

func ToCtx(ctx context.Context, s *Session) context.Context

Types

type Manager

type Manager struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func DefaultManager

func DefaultManager(store Store) *Manager

func NewManager

func NewManager(emptyCookie http.Cookie, ipStrict bool, store Store) *Manager

func (*Manager) Delete

func (m *Manager) Delete(session string) error

func (*Manager) Get

func (m *Manager) Get(session, key string) (interface{}, error)

func (*Manager) Session

func (m *Manager) Session(w http.ResponseWriter, r *http.Request) *Session

func (*Manager) Set

func (m *Manager) Set(session, key string, v interface{}) error

type Middleware

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

func (*Middleware) ServeHTTP

func (m *Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Session

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

func FromCtx

func FromCtx(ctx context.Context) (s *Session)

func (*Session) Get

func (s *Session) Get(name string) (interface{}, error)

Get gets variable from Session

func (*Session) Name

func (s *Session) Name() string

Name gets name of the Session

func (*Session) Set

func (s *Session) Set(name string, value interface{}) error

Set sets variable in Session

type Store

type Store interface {
	Get(key string) ([]byte, error)
	Set(key string, value []byte, ttl time.Duration) error
	Delete(key string) error
}