Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConsulStore ¶
type ConsulStore struct {
// contains filtered or unexported fields
}
ConsulStore represents the session store.
func New ¶
func New(client *api.Client) *ConsulStore
New returns a new ConsulStore instance. The client parameter should be a pointer to a Consul client instance.
func NewWithOptions ¶
NewWithOptions returns a new ConsulStore instance. The client parameter should be a pointer to a Consul client instance. The prefix parameter controls the Consul key prefix, which can be used to avoid naming clashes if necessary. 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 (*ConsulStore) All ¶
func (c *ConsulStore) All() (map[string][]byte, error)
All returns a map containing the token and data for all active (i.e. not expired) sessions in the ConsulStore instance.
func (*ConsulStore) Commit ¶
Commit adds a session token and data to the ConsulStore instance with the given expiry time. If the session token already exists then the data and expiry time are updated.
func (*ConsulStore) Delete ¶
func (c *ConsulStore) Delete(token string) error
Delete removes a session token and corresponding data from the ConsulStore instance.
func (*ConsulStore) Find ¶
func (c *ConsulStore) Find(token string) (b []byte, exists bool, err error)
Find returns the data for a given session token from the ConsulStore instance. If the session token is not found or is expired, the returned exists flag will be set to false.
func (*ConsulStore) StopCleanup ¶
func (c *ConsulStore) StopCleanup()
StopCleanup terminates the background cleanup goroutine for the ConsulStore instance. It's rare to terminate this; generally ConsulStore 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 ConsulStore is transient. An example is creating a new ConsulStore instance in a test function. In this scenario, the cleanup goroutine (which will run forever) will prevent the ConsulStore object from being garbage collected even after the test function has finished. You can prevent this by manually calling StopCleanup.