redis

Documentation

Index

• Constants
• type Config
  • func (mc *Config) Name() string
• type Provider
  • func NewProvider() *Provider
  • func (rp *Provider) Count() int
  • func (rp *Provider) Destroy(sessionID []byte) error
  • func (rp *Provider) GC()
  • func (rp *Provider) Get(sessionID []byte) (session.Storer, error)
  • func (rp *Provider) Init(expiration time.Duration, cfg session.ProviderConfig) error
  • func (rp *Provider) NeedGC() bool
  • func (rp *Provider) Put(store session.Storer)
  • func (rp *Provider) Regenerate(oldID, newID []byte) (session.Storer, error)
• type Store
  • func (rs *Store) Save() error

Constants

const ProviderName = "redis"

ProviderName redis provider name

Types

type Config

type Config struct {

	// Redis server host
	Host string

	// Redis server port
	Port int64

	// Maximum number of socket connections.
	PoolSize int

	// Close connections after remaining idle for this duration. If the value
	// is zero, then idle connections are not closed. Applications should set
	// the timeout to a value less than the server's timeout.
	// (s)
	IdleTimeout int64

	// redis server conn auth, default ""
	Password string

	// select db number, default 0
	DbNumber int

	// sessionID as redis key prefix
	KeyPrefix string

	// session value serialize func
	SerializeFunc func(src session.Dict) ([]byte, error)

	// session value unSerialize func
	UnSerializeFunc func(dst *session.Dict, src []byte) error
}

Config session redis config

func (*Config) Name

func (mc *Config) Name() string

Name return provider name

type Provider

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

Provider provider struct

func NewProvider

func NewProvider() *Provider

NewProvider new redis provider

func (*Provider) Count

func (rp *Provider) Count() int

Count session values count

func (*Provider) Destroy

func (rp *Provider) Destroy(sessionID []byte) error

Destroy destroy session by sessionID

func (*Provider) GC

func (rp *Provider) GC()

GC session redis provider not need garbage collection

func (*Provider) Get

func (rp *Provider) Get(sessionID []byte) (session.Storer, error)

Get read session store by session id

func (*Provider) Init

func (rp *Provider) Init(expiration time.Duration, cfg session.ProviderConfig) error

Init init provider config

func (*Provider) NeedGC

func (rp *Provider) NeedGC() bool

NeedGC not need gc

func (*Provider) Put

func (rp *Provider) Put(store session.Storer)

Put put store into the pool.

func (*Provider) Regenerate

func (rp *Provider) Regenerate(oldID, newID []byte) (session.Storer, error)

Regenerate regenerate session

type Store

type Store struct {
	session.Store
}

Store store struct

func (*Store) Save

func (rs *Store) Save() error

Save save store