Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

session

package

Go to main page

Versions in this module

v2

v2.3.105

Aug 13, 2025

v2.3.104

Mar 10, 2025

v2.3.103

Mar 10, 2025

v2.3.102

Mar 10, 2025

v2.3.101

Mar 10, 2025

Changes in this version

+ var SLogger = NewSessionLog(os.Stderr)

+ func DecodeGob(encoded []byte) (map[interface{}]interface{}, error)

+ func EncodeGob(obj map[interface{}]interface{}) ([]byte, error)

+ func Register(name string, provide Provider)

+ type CookieProvider struct

+ func (pder *CookieProvider) SessionAll(context.Context) int

+ func (pder *CookieProvider) SessionDestroy(ctx context.Context, sid string) error

+ func (pder *CookieProvider) SessionExist(ctx context.Context, sid string) (bool, error)

+ func (pder *CookieProvider) SessionGC(context.Context)

+ func (pder *CookieProvider) SessionInit(ctx context.Context, maxlifetime int64, config string) error

+ func (pder *CookieProvider) SessionRead(ctx context.Context, sid string) (Store, error)

+ func (pder *CookieProvider) SessionRegenerate(ctx context.Context, oldsid, sid string) (Store, error)

+ func (pder *CookieProvider) SessionUpdate(ctx context.Context, sid string) error

+ type CookieSessionStore struct

+ func (st *CookieSessionStore) Delete(ctx context.Context, key interface{}) error

+ func (st *CookieSessionStore) Flush(context.Context) error

+ func (st *CookieSessionStore) Get(ctx context.Context, key interface{}) interface{}

+ func (st *CookieSessionStore) SessionID(context.Context) string

+ func (st *CookieSessionStore) SessionRelease(_ context.Context, w http.ResponseWriter)

+ func (st *CookieSessionStore) SessionReleaseIfPresent(ctx context.Context, w http.ResponseWriter)

+ func (st *CookieSessionStore) Set(ctx context.Context, key, value interface{}) error

+ type FileProvider struct

+ func (fp *FileProvider) SessionAll(context.Context) int

+ func (fp *FileProvider) SessionDestroy(ctx context.Context, sid string) error

+ func (fp *FileProvider) SessionExist(ctx context.Context, sid string) (bool, error)

+ func (fp *FileProvider) SessionGC(context.Context)

+ func (fp *FileProvider) SessionInit(ctx context.Context, maxlifetime int64, savePath string) error

+ func (fp *FileProvider) SessionRead(ctx context.Context, sid string) (Store, error)

+ func (fp *FileProvider) SessionRegenerate(ctx context.Context, oldsid, sid string) (Store, error)

+ type FileSessionStore struct

+ func (fs *FileSessionStore) Delete(ctx context.Context, key interface{}) error

+ func (fs *FileSessionStore) Flush(context.Context) error

+ func (fs *FileSessionStore) Get(ctx context.Context, key interface{}) interface{}

+ func (fs *FileSessionStore) SessionID(context.Context) string

+ func (fs *FileSessionStore) SessionRelease(ctx context.Context, w http.ResponseWriter)

+ func (fs *FileSessionStore) SessionReleaseIfPresent(ctx context.Context, w http.ResponseWriter)

+ func (fs *FileSessionStore) Set(ctx context.Context, key, value interface{}) error

+ type Log struct

+ func NewSessionLog(out io.Writer) *Log

+ type Manager struct

+ func NewManager(provideName string, cf *ManagerConfig) (*Manager, error)

+ func (manager *Manager) GC()

+ func (manager *Manager) GetActiveSession() int

+ func (manager *Manager) GetProvider() Provider

+ func (manager *Manager) GetSessionStore(sid string) (sessions Store, err error)

+ func (manager *Manager) SessionDestroy(w http.ResponseWriter, r *http.Request)

+ func (manager *Manager) SessionRegenerateID(w http.ResponseWriter, r *http.Request) (Store, error)

+ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (session Store, err error)

+ func (manager *Manager) SetSecure(secure bool)

+ type ManagerConfig struct

+ CookieLifeTime int

+ CookieName string

+ CookieSameSite http.SameSite

+ DisableHTTPOnly bool

+ Domain string

+ EnableSetCookie bool

+ EnableSidInHTTPHeader bool

+ EnableSidInURLQuery bool

+ Gclifetime int64

+ Maxlifetime int64

+ ProviderConfig string

+ Secure bool

+ SessionIDLength int64

+ SessionIDPrefix string

+ SessionNameInHTTPHeader string

+ func NewManagerConfig(opts ...ManagerConfigOpt) *ManagerConfig

+ func (c *ManagerConfig) Opts(opts ...ManagerConfigOpt)

+ type ManagerConfigOpt func(config *ManagerConfig)

+ func CfgCookieLifeTime(lifeTime int) ManagerConfigOpt

+ func CfgCookieName(cookieName string) ManagerConfigOpt

+ func CfgDomain(domain string) ManagerConfigOpt

+ func CfgEnableSidInURLQuery(enable bool) ManagerConfigOpt

+ func CfgGcLifeTime(lifeTime int64) ManagerConfigOpt

+ func CfgHTTPOnly(HTTPOnly bool) ManagerConfigOpt

+ func CfgMaxLifeTime(lifeTime int64) ManagerConfigOpt

+ func CfgProviderConfig(providerConfig string) ManagerConfigOpt

+ func CfgSameSite(sameSite http.SameSite) ManagerConfigOpt

+ func CfgSecure(Enable bool) ManagerConfigOpt

+ func CfgSessionIdInHTTPHeader(enable bool) ManagerConfigOpt

+ func CfgSessionIdLength(length int64) ManagerConfigOpt

+ func CfgSessionIdPrefix(prefix string) ManagerConfigOpt

+ func CfgSetCookie(enable bool) ManagerConfigOpt

+ func CfgSetSessionNameInHTTPHeader(name string) ManagerConfigOpt

+ type MemProvider struct

+ func (pder *MemProvider) SessionAll(context.Context) int

+ func (pder *MemProvider) SessionDestroy(ctx context.Context, sid string) error

+ func (pder *MemProvider) SessionExist(ctx context.Context, sid string) (bool, error)

+ func (pder *MemProvider) SessionGC(context.Context)

+ func (pder *MemProvider) SessionInit(ctx context.Context, maxlifetime int64, savePath string) error

+ func (pder *MemProvider) SessionRead(ctx context.Context, sid string) (Store, error)

+ func (pder *MemProvider) SessionRegenerate(ctx context.Context, oldsid, sid string) (Store, error)

+ func (pder *MemProvider) SessionUpdate(ctx context.Context, sid string) error

+ type MemSessionStore struct

+ func (*MemSessionStore) SessionReleaseIfPresent(_ context.Context, _ http.ResponseWriter)

+ func (st *MemSessionStore) Delete(ctx context.Context, key interface{}) error

+ func (st *MemSessionStore) Flush(context.Context) error

+ func (st *MemSessionStore) Get(ctx context.Context, key interface{}) interface{}

+ func (st *MemSessionStore) SessionID(context.Context) string

+ func (st *MemSessionStore) SessionRelease(_ context.Context, _ http.ResponseWriter)

+ func (st *MemSessionStore) Set(ctx context.Context, key, value interface{}) error

+ type Provider interface

+ SessionAll func(ctx context.Context) int

+ SessionDestroy func(ctx context.Context, sid string) error

+ SessionExist func(ctx context.Context, sid string) (bool, error)

+ SessionGC func(ctx context.Context)

+ SessionInit func(ctx context.Context, gclifetime int64, config string) error

+ SessionRead func(ctx context.Context, sid string) (Store, error)

+ SessionRegenerate func(ctx context.Context, oldsid, sid string) (Store, error)

+ func GetProvider(name string) (Provider, error)

+ type ProviderType string

+ const ProviderCookie

+ const ProviderCouchbase

+ const ProviderFile

+ const ProviderLedis

+ const ProviderMemcache

+ const ProviderMemory

+ const ProviderMysql

+ const ProviderPostgresql

+ const ProviderRedis

+ const ProviderRedisCluster

+ const ProviderRedisSentinel

+ const ProviderSsdb

+ type Store interface

+ Delete func(ctx context.Context, key interface{}) error

+ Flush func(ctx context.Context) error

+ Get func(ctx context.Context, key interface{}) interface{}

+ SessionID func(ctx context.Context) string

+ SessionRelease func(ctx context.Context, w http.ResponseWriter)

+ SessionReleaseIfPresent func(ctx context.Context, w http.ResponseWriter)

+ Set func(ctx context.Context, key, value interface{}) error