session

Documentation

Index

• Variables
• type Options
• type Service
• type Session

Variables

var (
	// ErrSessionNotFound is error if session does not exist.
	ErrSessionNotFound = errors.New("session not found")
)

Types

type Options

type Options struct {
	Values *map[string]interface{} `json:"values,omitempty"`
	MaxAge *int                    `json:"max-age,omitempty"`
}

Options is a structure with parameters as pointers to set session data. If a parameter is nil, the corresponding Session parameter will not be changed.

type Service

type Service interface {
	// Session retrieves a Session instance.
	Session(id string) (*Session, error)
	// CreateSession creates a new Session instance.
	CreateSession(*Options) (*Session, error)
	// UpdateSession changes data of an existing Session.
	UpdateSession(id string, o *Options) (*Session, error)
	// DeleteSession deletes an existing Session.
	DeleteSession(id string) error
}

Service defines functions that Session provider must have.

type Session

type Session struct {
	// A unique Session ID.
	ID string `json:"id"`
	// A mapping of named arbitrary data that Session holds.
	Values map[string]interface{} `json:"values,omitempty"`
	// MaxAge is an integer that represents duration in seconds and
	// can be used in setting expiration of a HTTP cookie.
	MaxAge int `json:"max-age,omitempty"`
}

Session holds session ID and values associated.