aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Gillham <jonathan.gillham@gamil.com>2013-10-25 14:15:33 +0400
committerJonathan Gillham <jonathan.gillham@gamil.com>2013-10-25 14:15:33 +0400
commitcb4af09e63b4fa547369c43a1fa62c2c4ce5c2b7 (patch)
tree4e46fae32c9b1903dde0b9a6e9d9bdb82e8722e6
parentb5d868122c68458b92558e9239d6225af9106b52 (diff)
Updated store documentation.
-rw-r--r--store.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/store.go b/store.go
index a5cb867..5b43bc8 100644
--- a/store.go
+++ b/store.go
@@ -16,6 +16,15 @@ import (
)
// Store is an interface for custom session stores.
+//
+// Get should return a cached session.
+// New should create and return a new session.
+// Save should persist session to the underlying store implementation.
+//
+// Note that New should never return a nul session, even in the case of an error
+// if using the Registry infrastructure for caching of sessions in your store.
+//
+// See CookieStore and FilesystemStore for examples.
type Store interface {
Get(r *http.Request, name string) (*Session, error)
New(r *http.Request, name string) (*Session, error)