Documentation
¶
Index ¶
- type OptFunc
- type SQLite3Store
- func (p *SQLite3Store) All() (map[string][]byte, error)
- func (p *SQLite3Store) AllCtx(ctx context.Context) (map[string][]byte, error)
- func (p *SQLite3Store) Commit(token string, b []byte, expiry time.Time) error
- func (p *SQLite3Store) CommitCtx(ctx context.Context, token string, b []byte, expiry time.Time) error
- func (p *SQLite3Store) Delete(token string) error
- func (p *SQLite3Store) DeleteCtx(ctx context.Context, token string) error
- func (p *SQLite3Store) Find(token string) (b []byte, exists bool, err error)
- func (p *SQLite3Store) FindCtx(ctx context.Context, token string) (b []byte, exists bool, err error)
- func (p *SQLite3Store) StopCleanup()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OptFunc ¶
type OptFunc func(*SQLite3Store)
func WithCleanupInterval ¶
WithCleanupInterval sets a custom cleanup interval. The cleanupInterval parameter controls how frequently expired session data is removed by the background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine from running (i.e. expired sessions will not be removed).
type SQLite3Store ¶
type SQLite3Store struct {
// contains filtered or unexported fields
}
SQLite3Store represents the session store.
func New ¶
func New(db dbinterface.Querier, opts ...OptFunc) *SQLite3Store
New returns a new SQLite3Store instance, with a background cleanup goroutine that runs every 5 minutes to remove expired session data.
func (*SQLite3Store) All ¶
func (p *SQLite3Store) All() (map[string][]byte, error)
All returns a map containing the token and data for all active (i.e. not expired) sessions in the SQLite3Store instance.
func (*SQLite3Store) AllCtx ¶
AllCtx returns a map containing the token and data for all active (i.e. not expired) sessions in the SQLite3Store instance.
func (*SQLite3Store) Commit ¶
Commit adds a session token and data to the SQLite3Store instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.
func (*SQLite3Store) CommitCtx ¶
func (p *SQLite3Store) CommitCtx(ctx context.Context, token string, b []byte, expiry time.Time) error
CommitCtx adds a session token and data to the SQLite3Store instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.
func (*SQLite3Store) Delete ¶
func (p *SQLite3Store) Delete(token string) error
Delete removes a session token and corresponding data from the SQLite3Store instance.
func (*SQLite3Store) DeleteCtx ¶
func (p *SQLite3Store) DeleteCtx(ctx context.Context, token string) error
DeleteCtx removes a session token and corresponding data from the SQLite3Store instance.
func (*SQLite3Store) Find ¶
func (p *SQLite3Store) Find(token string) (b []byte, exists bool, err error)
Find returns the data for a given session token from the SQLite3Store instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*SQLite3Store) FindCtx ¶
func (p *SQLite3Store) FindCtx(ctx context.Context, token string) (b []byte, exists bool, err error)
FindCtx returns the data for a given session token from the SQLite3Store instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*SQLite3Store) StopCleanup ¶
func (p *SQLite3Store) StopCleanup()
StopCleanup terminates the background cleanup goroutine for the SQLite3Store instance. It's rare to terminate this; generally SQLite3Store instances and their cleanup goroutines are intended to be long-lived and run for the lifetime of your application.
There may be occasions though when your use of the SQLite3Store is transient. An example is creating a new SQLite3Store instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the SQLite3Store object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.
Source Files