mongodb

Documentation

Index

• type Config
  • func NewConfigWith(connectionUrl string, dbName string, collection string) Config
• type Provider
  • func New(cfg Config) (*Provider, error)
  • func (p *Provider) Count() int
  • func (p *Provider) Destroy(id []byte) error
  • func (p *Provider) GC() error
  • func (p *Provider) Get(id []byte) ([]byte, error)
  • func (p *Provider) NeedGC() bool
  • func (p *Provider) Regenerate(id []byte, newID []byte, expiration time.Duration) error
  • func (p *Provider) Save(id []byte, data []byte, expiration time.Duration) error

Types

type Config

type Config struct {
	ConnectionUrl string

	Database string

	Collection string
}

func NewConfigWith

func NewConfigWith(connectionUrl string, dbName string, collection string) Config

NewConfigWith returns a new configuration with specific parameters

type Provider

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

func New

func New(cfg Config) (*Provider, error)

New returns a new configured mongodb provider

func (*Provider) Count

func (p *Provider) Count() int

Count returns the total of stored sessions

func (*Provider) Destroy

func (p *Provider) Destroy(id []byte) error

Destroy destroys the session from the given id

func (*Provider) GC

func (p *Provider) GC() error

GC destroys the expired sessions

func (*Provider) Get

func (p *Provider) Get(id []byte) ([]byte, error)

Get returns the session value stored in the database.

func (*Provider) NeedGC

func (p *Provider) NeedGC() bool

NeedGC indicates if the GC needs to be run

func (*Provider) Regenerate

func (p *Provider) Regenerate(id []byte, newID []byte, expiration time.Duration) error

Regenerate updates the session id and expiration with the new session id of the the given current session id

func (*Provider) Save

func (p *Provider) Save(id []byte, data []byte, expiration time.Duration) error

Save saves the session data and expiration from the given session id