sessions

Documentation

Index

• func NewCookie(name, value string, options *Options) *http.Cookie
• type MemoryStore
  • func NewMemoryStore() *MemoryStore
  • func (s *MemoryStore) Delete(id string) error
  • func (s *MemoryStore) Get(id string, buf *bytes.Buffer) error
  • func (s *MemoryStore) Save(session *Session, buf *bytes.Buffer, w http.ResponseWriter) error
• type Options
• type Session
  • func (s *Session) AddFlash(value string)
  • func (s *Session) AddFlashs(values []string)
  • func (z *Session) DecodeMsg(dc *msgp.Reader) (err error)
  • func (s *Session) Delete(w http.ResponseWriter) error
  • func (z *Session) EncodeMsg(en *msgp.Writer) (err error)
  • func (s *Session) Flashes() []string
  • func (s *Session) GetBool(key string, def bool) bool
  • func (s *Session) GetFloat(key string, def float64) float64
  • func (s *Session) GetFloats(key string, def []float64) []float64
  • func (s *Session) GetInt(key string, def int64) int64
  • func (s *Session) GetInts(key string, def []int64) []int64
  • func (s *Session) GetString(key string, def string) string
  • func (s *Session) GetStrings(key string, def []string) []string
  • func (z *Session) MarshalMsg(b []byte) (o []byte, err error)
  • func (z *Session) Msgsize() (s int)
  • func (s *Session) Name() string
  • func (s *Session) Save(w http.ResponseWriter) error
  • func (s *Session) Set(key string, v interface{})
  • func (s *Session) SetAll(vals map[string]interface{})
  • func (z *Session) UnmarshalMsg(bts []byte) (o []byte, err error)
• type SessionManager
  • func New(poolSize int, store Store, options *Options) *SessionManager
  • func (s *SessionManager) Close(sessions *Sessions)
  • func (s *SessionManager) GetSessions(r *http.Request) *Sessions
• type Sessions
  • func (s *Sessions) Delete(w http.ResponseWriter) error
  • func (s *Sessions) Get(name string) *Session
  • func (s *Sessions) Save(w http.ResponseWriter) error
• type Store

Functions

func NewCookie

func NewCookie(name, value string, options *Options) *http.Cookie

Types

type MemoryStore

type MemoryStore struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewMemoryStore

func NewMemoryStore() *MemoryStore

func (*MemoryStore) Delete

func (s *MemoryStore) Delete(id string) error

func (*MemoryStore) Get

func (s *MemoryStore) Get(id string, buf *bytes.Buffer) error

func (*MemoryStore) Save

func (s *MemoryStore) Save(session *Session, buf *bytes.Buffer, w http.ResponseWriter) error

type Options

type Options struct {
	Path   string
	Domain string
	// MaxAge=0 means no 'Max-Age' attribute specified.
	// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'.
	// MaxAge>0 means Max-Age attribute present and given in seconds.
	MaxAge   int
	Secure   bool
	HttpOnly bool
}

type Session

type Session struct {
	ID      string                 `msg:"-"`
	Values  map[string]interface{} `msg:"v"`
	Options *Options               `msg:"-"`
	IsNew   bool                   `msg:"-"`
	// contains filtered or unexported fields
}

func (*Session) AddFlash

func (s *Session) AddFlash(value string)

AddFlash adds a flash message to the session.

A single variadic argument is accepted, and it is optional: it defines the flash key. If not defined "_flash" is used by default.

func (*Session) AddFlashs

func (s *Session) AddFlashs(values []string)

func (*Session) DecodeMsg

func (z *Session) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Session) Delete

func (s *Session) Delete(w http.ResponseWriter) error

func (*Session) EncodeMsg

func (z *Session) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*Session) Flashes

func (s *Session) Flashes() []string

Flashes returns a slice of flash messages from the session.

A single variadic argument is accepted, and it is optional: it defines the flash key. If not defined "_flash" is used by default.

func (*Session) GetBool

func (s *Session) GetBool(key string, def bool) bool

GetBool return bool value

func (*Session) GetFloat

func (s *Session) GetFloat(key string, def float64) float64

GetFloat return float64 value

func (*Session) GetFloats

func (s *Session) GetFloats(key string, def []float64) []float64

GetFloats return array float64 value

func (*Session) GetInt

func (s *Session) GetInt(key string, def int64) int64

GetInt return int64 value

func (*Session) GetInts

func (s *Session) GetInts(key string, def []int64) []int64

GetInts return array int64 value

func (*Session) GetString

func (s *Session) GetString(key string, def string) string

GetString return string value

func (*Session) GetStrings

func (s *Session) GetStrings(key string, def []string) []string

GetStrings return array string value

func (*Session) MarshalMsg

func (z *Session) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Session) Msgsize

func (z *Session) Msgsize() (s int)

func (*Session) Name

func (s *Session) Name() string

func (*Session) Save

func (s *Session) Save(w http.ResponseWriter) error

func (*Session) Set

func (s *Session) Set(key string, v interface{})

func (*Session) SetAll

func (s *Session) SetAll(vals map[string]interface{})

func (*Session) UnmarshalMsg

func (z *Session) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type SessionManager

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

func New

func New(poolSize int, store Store, options *Options) *SessionManager

func (*SessionManager) Close

func (s *SessionManager) Close(sessions *Sessions)

func (*SessionManager) GetSessions

func (s *SessionManager) GetSessions(r *http.Request) *Sessions

type Sessions

type Sessions struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*Sessions) Delete

func (s *Sessions) Delete(w http.ResponseWriter) error

func (*Sessions) Get

func (s *Sessions) Get(name string) *Session

func (*Sessions) Save

func (s *Sessions) Save(w http.ResponseWriter) error

type Store

type Store interface {
	Get(id string, buf *bytes.Buffer) error
	Save(session *Session, buf *bytes.Buffer, w http.ResponseWriter) error
	Delete(session *Session, w http.ResponseWriter) error
}