update comment for package gsession
@@ -16,22 +16,22 @@ type Storage interface {
// This function can be used for custom session creation.
New(ttl time.Duration) (id string)
- // Get retrieves session value with given key.
+ // Get retrieves and returns session value with given key.
// It returns nil if the key does not exist in the session.
Get(id string, key string) interface{}
// GetMap retrieves all key-value pairs as map from storage.
GetMap(id string) map[string]interface{}
- // GetSize retrieves the size of key-value pairs from storage.
+ // GetSize retrieves and returns the size of key-value pairs from storage.
GetSize(id string) int
- // Set sets key-value session pair to the storage.
- // The parameter <ttl> specifies the TTL for the session id (not for the key-value pair).
+ // Set sets one key-value session pair to the storage.
+ // The parameter <ttl> specifies the TTL for the session id.
Set(id string, key string, value interface{}, ttl time.Duration) error
- // SetMap batch sets key-value session pairs with map to the storage.
- // The parameter <ttl> specifies the TTL for the session id(not for the key-value pair).
+ // SetMap batch sets key-value session pairs as map to the storage.
+ // The parameter <ttl> specifies the TTL for the session id.
SetMap(id string, data map[string]interface{}, ttl time.Duration) error
// Remove deletes key with its value from storage.
@@ -42,11 +42,11 @@ type Storage interface {
// GetSession returns the session data as *gmap.StrAnyMap for given session id from storage.
//
- // The parameter <ttl> specifies the TTL for this session, and it returns nil if the TTL is exceeded.
+ // The parameter <ttl> specifies the TTL for this session.
// The parameter <data> is the current old session data stored in memory,
// and for some storage it might be nil if memory storage is disabled.
//
- // This function is called ever when session starts.
+ // This function is called ever when session starts. It returns nil if the TTL is exceeded.
GetSession(id string, ttl time.Duration, data *gmap.StrAnyMap) (*gmap.StrAnyMap, error)
// SetSession updates the data for specified session id.
