gsession

README

GMC Session module

Testing And Code coverage

# go test -cover -v
=== RUN   TestNewSession
--- PASS: TestNewSession (1.00s)
=== RUN   TestSerialize
--- PASS: TestSerialize (0.00s)
=== RUN   TestUnserialize
--- PASS: TestUnserialize (0.00s)
PASS
coverage: 95.6% of statements
ok  	github.com/snail007/gmc/http/session	1.017s

Documentation

Index

• func ExistsDir(path string) bool
• func ExistsFile(path string) bool
• func Init(config gcore.Config) (sessionStore gcore.SessionStorage, err error)
• func NewFileStore(config interface{}) (st gcore.SessionStorage, err error)
• func NewMemoryStore(config interface{}) (st gcore.SessionStorage, err error)
• func NewRedisStore(config interface{}) (st gcore.SessionStorage, err error)
• type FileStore
  • func (s *FileStore) Delete(sessionID string) (err error)
  • func (s *FileStore) Load(sessionID string) (sess gcore.Session, isExists bool)
  • func (s *FileStore) Save(sess gcore.Session) (err error)
• type FileStoreConfig
  • func NewFileStoreConfig() FileStoreConfig
• type MemoryStore
  • func (s *MemoryStore) Delete(sessionID string) (err error)
  • func (s *MemoryStore) Load(sessionID string) (sess gcore.Session, isExists bool)
  • func (s *MemoryStore) Save(sess gcore.Session) (err error)
• type MemoryStoreConfig
  • func NewMemoryStoreConfig() MemoryStoreConfig
• type RedisStore
  • func (s *RedisStore) Delete(sessionID string) (err error)
  • func (s *RedisStore) Load(sessionID string) (sess gcore.Session, isExists bool)
  • func (s *RedisStore) Save(sess gcore.Session) (err error)
• type RedisStoreConfig
  • func NewRedisStoreConfig() RedisStoreConfig
• type Session
  • func NewSession() *Session
  • func (s *Session) Delete(k interface{}) (err error)
  • func (s *Session) Destroy() (err error)
  • func (s *Session) Get(k interface{}) (value interface{})
  • func (s *Session) IsDestroy() bool
  • func (s *Session) Serialize() (str string, err error)
  • func (s *Session) SessionID() (sessionID string)
  • func (s *Session) Set(k interface{}, v interface{})
  • func (s *Session) Touch()
  • func (s *Session) TouchTime() (time int64)
  • func (s *Session) Unserialize(data string) (err error)
  • func (s *Session) Values() (data map[interface{}]interface{})

Functions

func ExistsDir

func ExistsDir(path string) bool

func ExistsFile

func ExistsFile(path string) bool

func Init

func Init(config gcore.Config) (sessionStore gcore.SessionStorage, err error)

func NewFileStore

func NewFileStore(config interface{}) (st gcore.SessionStorage, err error)

func NewMemoryStore

func NewMemoryStore(config interface{}) (st gcore.SessionStorage, err error)

func NewRedisStore

func NewRedisStore(config interface{}) (st gcore.SessionStorage, err error)

Types

type FileStore

type FileStore struct {
	gcore.SessionStorage
	// contains filtered or unexported fields
}

func (*FileStore) Delete

func (s *FileStore) Delete(sessionID string) (err error)

func (*FileStore) Load

func (s *FileStore) Load(sessionID string) (sess gcore.Session, isExists bool)

func (*FileStore) Save

func (s *FileStore) Save(sess gcore.Session) (err error)

type FileStoreConfig

type FileStoreConfig struct {
	Dir    string
	GCtime int //seconds
	Prefix string
	Logger gcore.Logger
	TTL    int64 //seconds
}

func NewFileStoreConfig

func NewFileStoreConfig() FileStoreConfig

type MemoryStore

type MemoryStore struct {
	gcore.SessionStorage
	// contains filtered or unexported fields
}

func (*MemoryStore) Delete

func (s *MemoryStore) Delete(sessionID string) (err error)

func (*MemoryStore) Load

func (s *MemoryStore) Load(sessionID string) (sess gcore.Session, isExists bool)

func (*MemoryStore) Save

func (s *MemoryStore) Save(sess gcore.Session) (err error)

type MemoryStoreConfig

type MemoryStoreConfig struct {
	GCtime int //seconds
	Logger gcore.Logger
	TTL    int64 //seconds
}

func NewMemoryStoreConfig

func NewMemoryStoreConfig() MemoryStoreConfig

type RedisStore

type RedisStore struct {
	gcore.SessionStorage
	// contains filtered or unexported fields
}

func (*RedisStore) Delete

func (s *RedisStore) Delete(sessionID string) (err error)

func (*RedisStore) Load

func (s *RedisStore) Load(sessionID string) (sess gcore.Session, isExists bool)

func (*RedisStore) Save

func (s *RedisStore) Save(sess gcore.Session) (err error)

type RedisStoreConfig

type RedisStoreConfig struct {
	TTL      int64 //seconds
	RedisCfg *gcache.RedisCacheConfig
	Logger   gcore.Logger
}

func NewRedisStoreConfig

func NewRedisStoreConfig() RedisStoreConfig

type Session

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

func NewSession

func NewSession() *Session

func (*Session) Delete

func (s *Session) Delete(k interface{}) (err error)

func (*Session) Destroy

func (s *Session) Destroy() (err error)

func (*Session) Get

func (s *Session) Get(k interface{}) (value interface{})

func (*Session) IsDestroy

func (s *Session) IsDestroy() bool

func (*Session) Serialize

func (s *Session) Serialize() (str string, err error)

func (*Session) SessionID

func (s *Session) SessionID() (sessionID string)

func (*Session) Set

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

func (*Session) Touch

func (s *Session) Touch()

func (*Session) TouchTime

func (s *Session) TouchTime() (time int64)

TouchTime return the last access unix time seconds of session.

func (*Session) Unserialize

func (s *Session) Unserialize(data string) (err error)

func (*Session) Values

func (s *Session) Values() (data map[interface{}]interface{})