Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SQLiteStore ¶
type SQLiteStore struct {
// contains filtered or unexported fields
}
SQLiteStore represents the session store.
func NewSQLiteStore ¶
func NewSQLiteStore(readDB *sql.DB, writeDB *sql.DB) *SQLiteStore
NewSQLiteStore returns a new SQLiteStore instance, with a background cleanup goroutine that runs every 5 minutes to remove expired session data.
func NewSQLiteStoreWithCleanupInterval ¶
func NewSQLiteStoreWithCleanupInterval(readDB *sql.DB, writeDB *sql.DB, cleanupInterval time.Duration) *SQLiteStore
NewSQLiteStoreWithCleanupInterval returns a new SQLiteStore instance. 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).
func (*SQLiteStore) All ¶
func (p *SQLiteStore) All() (map[string][]byte, error)
All returns a map containing the token and data for all active (i.e. not expired) sessions in the SQLiteStore instance.
func (*SQLiteStore) Commit ¶
Commit adds a session token and data to the SQLiteStore instance with the given expiry time. If the session token already exists, then the data and expiry time are updated.
func (*SQLiteStore) Delete ¶
func (p *SQLiteStore) Delete(token string) error
Delete removes a session token and corresponding data from the SQLiteStore instance.
func (*SQLiteStore) Find ¶
func (p *SQLiteStore) Find(token string) (b []byte, exists bool, err error)
Find returns the data for a given session token from the SQLiteStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*SQLiteStore) StopCleanup ¶
func (p *SQLiteStore) StopCleanup()
StopCleanup terminates the background cleanup goroutine for the SQLiteStore instance. It's rare to terminate this; generally SQLiteStore 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 SQLiteStore is transient. An example is creating a new SQLiteStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the SQLiteStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.
Source Files