session

README

session

Simple session for Go.

Documentation

Index

• type MemoryStore
  • func NewMemoryStore(maxAge int) *MemoryStore
  • func (s *MemoryStore) Close() error
  • func (s *MemoryStore) Has(id string) (bool, error)
  • func (s *MemoryStore) Load(id string) (*Session, error)
  • func (s *MemoryStore) Renew(session *Session) error
  • func (s *MemoryStore) Revoke(id string) error
  • func (s *MemoryStore) Save(session *Session) error
• type MongoStore
  • func NewMongoStore(c *mgo.Collection, maxAge int) *MongoStore
  • func (s *MongoStore) Close() error
  • func (s *MongoStore) Has(id string) (bool, error)
  • func (s *MongoStore) Load(id string) (*Session, error)
  • func (s *MongoStore) Renew(session *Session) error
  • func (s *MongoStore) Revoke(id string) error
  • func (s *MongoStore) Save(session *Session) error
• type MySQLStore
  • func NewMySQLStore(db *sql.DB, maxAge int) *MySQLStore
  • func (s *MySQLStore) Close() error
  • func (s *MySQLStore) Has(id string) (bool, error)
  • func (s *MySQLStore) Load(id string) (*Session, error)
  • func (s *MySQLStore) Renew(session *Session) error
  • func (s *MySQLStore) Revoke(id string) error
  • func (s *MySQLStore) Save(session *Session) error
• type Session
  • func NewSession(id string) *Session
  • func (s *Session) ExpiresAt() time.Time
  • func (s *Session) Get(key string) interface{}
  • func (s *Session) Has(key string) bool
  • func (s *Session) Id() string
  • func (s *Session) Set(key string, value interface{})
  • func (s *Session) Unset(key string)
• type Store

Types

type MemoryStore

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

func NewMemoryStore

func NewMemoryStore(maxAge int) *MemoryStore

func (*MemoryStore) Close

func (s *MemoryStore) Close() error

func (*MemoryStore) Has

func (s *MemoryStore) Has(id string) (bool, error)

func (*MemoryStore) Load

func (s *MemoryStore) Load(id string) (*Session, error)

func (*MemoryStore) Renew

func (s *MemoryStore) Renew(session *Session) error

func (*MemoryStore) Revoke

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

func (*MemoryStore) Save

func (s *MemoryStore) Save(session *Session) error

type MongoStore

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

func NewMongoStore

func NewMongoStore(c *mgo.Collection, maxAge int) *MongoStore

func (*MongoStore) Close

func (s *MongoStore) Close() error

func (*MongoStore) Has

func (s *MongoStore) Has(id string) (bool, error)

func (*MongoStore) Load

func (s *MongoStore) Load(id string) (*Session, error)

func (*MongoStore) Renew

func (s *MongoStore) Renew(session *Session) error

func (*MongoStore) Revoke

func (s *MongoStore) Revoke(id string) error

func (*MongoStore) Save

func (s *MongoStore) Save(session *Session) error

type MySQLStore

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

require parseTime=true if use with github.com/go-sql-driver/mysql Schema: CREATE TABLE `session` (

`id` VARCHAR(40) NOT NULL,
`expires_at` DATETIME NOT NULL,
`data` text NOT NULL,
PRIMARY KEY (`id`));

func NewMySQLStore

func NewMySQLStore(db *sql.DB, maxAge int) *MySQLStore

func (*MySQLStore) Close

func (s *MySQLStore) Close() error

func (*MySQLStore) Has

func (s *MySQLStore) Has(id string) (bool, error)

func (*MySQLStore) Load

func (s *MySQLStore) Load(id string) (*Session, error)

func (*MySQLStore) Renew

func (s *MySQLStore) Renew(session *Session) error

func (*MySQLStore) Revoke

func (s *MySQLStore) Revoke(id string) error

func (*MySQLStore) Save

func (s *MySQLStore) Save(session *Session) error

type Session

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

func NewSession

func NewSession(id string) *Session

func (*Session) ExpiresAt

func (s *Session) ExpiresAt() time.Time

func (*Session) Get

func (s *Session) Get(key string) interface{}

func (*Session) Has

func (s *Session) Has(key string) bool

func (*Session) Id

func (s *Session) Id() string

func (*Session) Set

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

func (*Session) Unset

func (s *Session) Unset(key string)

type Store

type Store interface {
	// Check session existence
	Has(id string) (bool, error)

	// Load a session by id, if not found, return nil
	Load(id string) (*Session, error)

	// Delete a session
	Revoke(id string) error

	// Extend session expiry
	Renew(session *Session) error

	// Save a session. Session expiry gets updated too
	Save(session *Session) error

	// Clean up
	Close() error
}