session

Documentation

Index

• func Clear(ctx context.Context)
• func ClearStack(ctx context.Context, stack string)
• func ClientTimezoneOffset(ctx context.Context) int
• func Get(ctx context.Context, key string) (v interface{})
• func GetBool(ctx context.Context, key string) (v bool)
• func GetFloat32(ctx context.Context, key string) (v float32)
• func GetFloat64(ctx context.Context, key string) (v float64)
• func GetInt(ctx context.Context, key string) (v int)
• func GetString(ctx context.Context, key string) (v string)
• func Has(ctx context.Context, key string) bool
• func PopStack(ctx context.Context, stack string) (value string)
• func PushStack(ctx context.Context, stack string, value string)
• func Remove(ctx context.Context, key string)
• func Reset(ctx context.Context)
• func Set(ctx context.Context, key string, v interface{})
• func SetBool(ctx context.Context, key string, v bool)
• func SetClientTimezoneOffset(ctx context.Context, offset int)
• func SetFloat32(ctx context.Context, key string, v float32)
• func SetFloat64(ctx context.Context, key string, v float64)
• func SetInt(ctx context.Context, key string, v int)
• func SetSessionManager(m ManagerI)
• func SetString(ctx context.Context, key string, v string)
• func Use(next http.Handler) http.Handler
• type ManagerI
  • func NewScsManager(mgr *scs.SessionManager) ManagerI
  • func SessionManager() ManagerI
• type Mock
  • func NewMock() *Mock
  • func (mgr Mock) Use(next http.Handler) http.Handler
  • func (mgr Mock) With(ctx context.Context) context.Context
• type ScsManager
  • func (mgr ScsManager) Use(next http.Handler) http.Handler
• type Session
  • func NewSession() *Session
  • func (s *Session) MarshalBinary() ([]byte, error)
  • func (s *Session) UnmarshalBinary(data []byte) error

Functions

func Clear

func Clear(ctx context.Context)

Clear removes all of the values from the session store. It does not remove the session token itself (the Cookie for example). To remove the token also, call Reset() in addition to Clear()

func ClearStack

func ClearStack(ctx context.Context, stack string)

ClearStack clears the named stack

func ClientTimezoneOffset

func ClientTimezoneOffset(ctx context.Context) int

ClientTimezoneOffset returns the timezone offset of the browser in minutes from UTC. For example, if the browser is at Pacific Standard Time, which is -8 UTC, this value will be -480. This value is not initialized the very first time a user enters the site, but after the user responds to an Ajax or Server request, it will have a valid value.

If it has not been initialized, it will return -1.

func Get

func Get(ctx context.Context, key string) (v interface{})

Get returns an interface value stored a the given key. nil is returned if nothing is there.

func GetBool

func GetBool(ctx context.Context, key string) (v bool)

GetBool returns the boolean at the given key in the session store. If the key does not exist OR if what does exist at that key is not a boolean, false will be returned.

func GetFloat32

func GetFloat32(ctx context.Context, key string) (v float32)

GetFloat32 returns the float32 at the given key in the session store. If the key does not exist OR if what does exist at that key is not a float, 0 will be returned.

func GetFloat64

func GetFloat64(ctx context.Context, key string) (v float64)

GetFloat64 returns the float64 at the given key in the session store. If the key does not exist OR if what does exist at that key is not a float, 0 will be returned.

func GetInt

func GetInt(ctx context.Context, key string) (v int)

GetInt returns the integer at the given key in the session store. If the key does not exist OR if what does exists at that key is not an integer, zero will be returned. Call Has() if the zero value has meaning for you and you want to check for existence.

func GetString

func GetString(ctx context.Context, key string) (v string)

GetString returns the string at the given key in the session store. If the key does not exist OR if what does exist at that key is not a string, an empty string will be returned.

func Has

func Has(ctx context.Context, key string) bool

Has returns true if the given key exists in the session store

func PopStack

func PopStack(ctx context.Context, stack string) (value string)

PopStack pops the given value off of the named stack and returns it.

func PushStack

func PushStack(ctx context.Context, stack string, value string)

PushStack pushes the given value onto the given named stack in the session. The name becomes a variable in the current session. The value must be JsonSerializable.

func Remove

func Remove(ctx context.Context, key string)

Remove will remove the value at the given key in the session store.

func Reset

func Reset(ctx context.Context)

Reset will destroy the old session token. If you also call Clear, or don't have any session data after processing the request, it will remove the session token all together after the request. If you do have session data, this will cause the session data to be moved to a new session token.

func Set

func Set(ctx context.Context, key string, v interface{})

Set will put the value at the given key in the session store. v must be serializable

func SetBool

func SetBool(ctx context.Context, key string, v bool)

SetBool will put the bool value at the given key in the session store.

func SetClientTimezoneOffset

func SetClientTimezoneOffset(ctx context.Context, offset int)

SetClientTimezoneOffset is used by the framework to remember the timezone offset as reported by the client. It is put in the session in order to remember it as the user navigates the website, since we can only get the timezone offset after the user responds to the first web page.

func SetFloat32

func SetFloat32(ctx context.Context, key string, v float32)

SetFloat32 will put the float32 value at the given key in the session store.

func SetFloat64

func SetFloat64(ctx context.Context, key string, v float64)

SetFloat64 will put the float64 value at the given key in the session store.

func SetInt

func SetInt(ctx context.Context, key string, v int)

SetInt will put the int value at the given key in the session store.

func SetSessionManager

func SetSessionManager(m ManagerI)

SetSessionManager injects the given session manager as the global session manager

func SetString

func SetString(ctx context.Context, key string, v string)

SetString will put the string value at the given key in the session store.

func Use

func Use(next http.Handler) http.Handler

Use injects the session manager into the page management process. It adds to the context in the Request object so that later session requests can get to the session information, and also wraps the given handler in pre and post processing functions. It should be called from your middleware processing stack.

Types

type ManagerI

type ManagerI interface {
	// Use wraps the given handler in session management stuff. It must decode the session and put it into the sessionContext key in the context
	// before processing the request, and then encode the session data after the request. See the ScsManager for an example.
	Use(http.Handler) http.Handler
}

ManagerI is the interface for session managers.

func NewScsManager

func NewScsManager(mgr *scs.SessionManager) ManagerI

func SessionManager

func SessionManager() ManagerI

type Mock

type Mock struct {
}

func NewMock

func NewMock() *Mock

func (Mock) Use

func (mgr Mock) Use(next http.Handler) http.Handler

func (Mock) With

func (mgr Mock) With(ctx context.Context) context.Context

Call with to insert the mock session into the current session

type ScsManager

type ScsManager struct {
	*scs.SessionManager
}

ScsManager satisfies the ManagerI interface for the github.com/alexedwards/scs session manager.

func (ScsManager) Use

func (mgr ScsManager) Use(next http.Handler) http.Handler

Use is an http handler that wraps the session management process. It will get and put session data into the http context.

type Session

type Session struct {
	*maps.SafeMap // container for session data
}

Session is the object that is stored in the context. (Actually a pointer to that object). You normally do not work with the Session object, but instead should call session.GetInt, session.SetInt, etc. Session is exported so that it can be created by custom session managers.

func NewSession

func NewSession() *Session

NewSession creates a new session object for use by session managers. You should not normally need to call this. To reset the session data, call Reset()

func (*Session) MarshalBinary

func (s *Session) MarshalBinary() ([]byte, error)

MarshallBinary serializes the session data for storage.

func (*Session) UnmarshalBinary

func (s *Session) UnmarshalBinary(data []byte) error

UnmarshallBinary unserializes saved session data