Server sessions

Technical reference of Sesiones del servidor.

This API is used in Sessions configuration.

Symbols

Symbol	Class	Description
ErrSessionNotAvailable	`var`	`ErrSessionNotAvailable` it exposes a shared value of the package.
ErrSessionInvalidKey	`var`	`ErrSessionInvalidKey` it exposes a shared value of the package.
ErrSessionInvalidOut	`var`	`ErrSessionInvalidOut` it exposes a shared value of the package.
ErrSessionExpired	`var`	`ErrSessionExpired` it exposes a shared value of the package.
SessionConfig	`type`	`SessionConfig` defines a public type of API.
SessionStorage	`type`	`SessionStorage` defines a public type of API.
SessionStorageConfig	`type`	`SessionStorageConfig` defines a public type of API.
SessionStorageRuntime	`type`	`SessionStorageRuntime` defines a public type of API.
SessionOpenStatus	`type`	`SessionOpenStatus` defines a public type of API.
SessionOpenMissing	`const`	`SessionOpenMissing` defines a constant value of the API.
SessionOpenOpened	`const`	`SessionOpenOpened` defines a constant value of the API.
SessionOpenInvalidToken	`const`	`SessionOpenInvalidToken` defines a constant value of the API.
SessionOpenExpired	`const`	`SessionOpenExpired` defines a constant value of the API.
SessionOpenRequest	`type`	`SessionOpenRequest` defines a public type of API.
SessionOpenResult	`type`	`SessionOpenResult` defines a public type of API.
SessionOpenResult.Opened	`func`	Open up. `Opened`.
SessionStorageInstance	`type`	`SessionStorageInstance` defines a public type of API.
SessionMeta	`type`	`SessionMeta` defines a public type of API.
SessionExpireFunc	`type`	`SessionExpireFunc` defines a public type of API.
SessionEventKind	`type`	`SessionEventKind` defines a public type of API.
SessionEventExpired	`const`	`SessionEventExpired` defines a constant value of the API.
SessionEventDestroyed	`const`	`SessionEventDestroyed` defines a constant value of the API.
SessionEvent	`type`	`SessionEvent` defines a public type of API.
SessionEventFunc	`type`	`SessionEventFunc` defines a public type of API.
SessionRotateFunc	`type`	`SessionRotateFunc` defines a public type of API.
SessionDestroyFunc	`type`	`SessionDestroyFunc` defines a public type of API.
SessionSaveFunc	`type`	`SessionSaveFunc` defines a public type of API.
Session	`type`	`Session` defines a public type of API.
ExpireSession	`type`	`ExpireSession` defines a public type of API.
NewSession	`func`	Build `NewSession`.
NewSessionReference	`func`	Build `NewSessionReference`.
NewSessionWithRotate	`func`	Build `NewSessionWithRotate`.
NewSessionWithLifecycle	`func`	Build `NewSessionWithLifecycle`.
DetachSession	`func`	It creates a life-cycle session without callbacks.
Session.ID	`func`	Return the identifier.
Session.Token	`func`	Give back the session token.
Session.Destroy	`func`	Destroy the session and block new mutations.
Session.IsDestroyed	`func`	Indicates the state of `IsDestroyed`.
NewExpireSession	`func`	Build `NewExpireSession`.
ExpireSession.ID	`func`	Return the identifier.
ExpireSession.Token	`func`	Give back the session token.
ExpireSession.CreatedAt	`func`	Crea `CreatedAt`.
ExpireSession.LastUpdate	`func`	Returns the instant of the latest update.
ExpireSession.ExpireAt	`func`	It returns the moment of expiry.
ExpireSession.Get	`func`	It gets the first value associated with a key.
ExpireSession.Has	`func`	It indicates whether the collection contains the key.
ExpireSession.GetAll	`func`	It gets all the values associated with a key.
ExpireSession.GetTTL	`func`	Get it. `GetTTL`.
Session.Get	`func`	It gets the first value associated with a key.
Session.Set	`func`	Set or replace a value.
Session.Has	`func`	It indicates whether the collection contains the key.
Session.GetAll	`func`	It gets all the values associated with a key.
Session.Delete	`func`	Eliminates the value associated with a key.
Session.Rotate	`func`	Rota `Rotate`.
Session.Clear	`func`	Clean `Clear`.
Session.Save	`func`	The remaining changes remain.
Session.SetTTL	`func`	Sets `SetTTL`.
Session.GetTTL	`func`	Get it. `GetTTL`.
MemorySessionAdapter	`type`	`MemorySessionAdapter` defines a public type of API.
NewMemorySessionAdapter	`func`	Build `NewMemorySessionAdapter`.
MemorySessionStorage	`func`	Returns the session storage in memory.
MemorySessionAdapter.GetName	`func`	Get it. `GetName`.
MemorySessionAdapter.OpenSessionStorage	`func`	Open up. `OpenSessionStorage`.
SessionTrace	`type`	`SessionTrace` defines a public type of API.
SessionTraceField	`type`	`SessionTraceField` defines a public type of API.
SessionTraceStage	`type`	`SessionTraceStage` defines a public type of API.
NewSessionTrace	`func`	Build `NewSessionTrace`.
SessionTrace.Now	`func`	Returns the watch used by the track.
SessionTrace.Add	`func`	Add `Add`.
SessionTrace.AddDuration	`func`	Add `AddDuration`.
SessionTrace.AddField	`func`	Add `AddField`.
SessionTrace.AddBool	`func`	Add `AddBool`.
SessionTrace.Fields	`func`	Give back a copy of the trace fields.
SessionTrace.Stages	`func`	Returns a copy of the tracks.

ErrSessionNotAvailable

Declaration:

gox

ErrSessionNotAvailable = errors.New("session is not available")

ErrSessionNotAvailable it exposes a shared value of the package.

ErrSessionInvalidKey

Declaration:

gox

ErrSessionInvalidKey   = errors.New("session key is invalid")

ErrSessionInvalidKey it exposes a shared value of the package.

ErrSessionInvalidOut

Declaration:

gox

ErrSessionInvalidOut   = errors.New("session output target is invalid")

ErrSessionInvalidOut it exposes a shared value of the package.

ErrSessionExpired

Declaration:

gox

ErrSessionExpired      = errors.New("session is expired")

ErrSessionExpired it exposes a shared value of the package.

SessionConfig

Declaration:

gox

type SessionConfig struct {
	TTL      time.Duration
	OnCreate func(session *Session)
	OnExpire func(session *ExpireSession)
}

SessionConfig defines a public type of API.

Fields

Field	Type	Description
`TTL`	`time.Duration`	Life time.
`OnCreate`	`func(session *Session)`	Public data associated with `OnCreate`.
`OnExpire`	`func(session *ExpireSession)`	Public data associated with `OnExpire`.

SessionStorage

Declaration:

gox

type SessionStorage interface {
	GetName() string
	OpenSessionStorage(ctx context.Context, config SessionStorageConfig) (SessionStorageRuntime, error)
}

SessionStorage defines a public type of API.

SessionStorageConfig

Declaration:

gox

type SessionStorageConfig struct {
	ProjectName string
	TTL         time.Duration
}

SessionStorageConfig defines a public type of API.

Fields

Field	Type	Description
`ProjectName`	`string`	Name of the element.
`TTL`	`time.Duration`	Life time.

SessionStorageRuntime

Declaration:

gox

type SessionStorageRuntime interface {
	GetName() string
	Close() error

	OpenSession(ctx context.Context, request SessionOpenRequest) (SessionOpenResult, error)
	GetSession(ctx context.Context, sessionID string) (SessionStorageInstance, error)
	CreateSession(ctx context.Context, meta *SessionMeta) (SessionStorageInstance, error)
	SaveSession(ctx context.Context, sessionID string) error
	TouchSession(ctx context.Context, sessionID string, ttl time.Duration) error
	DeleteSession(ctx context.Context, sessionID string) error

	SubscribeSessionEvents(ctx context.Context, fn SessionEventFunc) error
}

SessionStorageRuntime defines a public type of API.

SessionOpenStatus

Declaration:

gox

type SessionOpenStatus uint8

SessionOpenStatus defines a public type of API.

SessionOpenMissing

Declaration:

gox

SessionOpenMissing SessionOpenStatus = iota

SessionOpenMissing defines a constant value of the API.

SessionOpenOpened

Declaration:

gox

SessionOpenOpened

SessionOpenOpened defines a constant value of the API.

SessionOpenInvalidToken

Declaration:

gox

SessionOpenInvalidToken

SessionOpenInvalidToken defines a constant value of the API.

SessionOpenExpired

Declaration:

gox

SessionOpenExpired

SessionOpenExpired defines a constant value of the API.

SessionOpenRequest

Declaration:

gox

type SessionOpenRequest struct {
	ID    string
	Token string
	TTL   time.Duration
	Now   time.Time
	Trace *SessionTrace
}

SessionOpenRequest defines a public type of API.

Fields

Field	Type	Description
`ID`	`string`	Unique identifier.
`Token`	`string`	Token associate.
`TTL`	`time.Duration`	Life time.
`Now`	`time.Time`	Public data associated with `Now`.
`Trace`	`*SessionTrace`	Public data associated with `Trace`.

SessionOpenResult

Declaration:

gox

type SessionOpenResult struct {
	Status   SessionOpenStatus
	Instance SessionStorageInstance
}

SessionOpenResult defines a public type of API.

Fields

Field	Type	Description
`Status`	`SessionOpenStatus`	Status of the operation.
`Instance`	`SessionStorageInstance`	Associated jurisdiction.

SessionOpenResult.Opened

Declaration:

gox

func (r SessionOpenResult) Opened() bool

Open up. Opened.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.

Usage syntax

gox

value := sessionOpenResult.Opened()

SessionStorageInstance

Declaration:

gox

type SessionStorageInstance interface {
	ID() string
	Token() string

	Get(key string, out any) (bool, error)
	Has(key string) bool
	GetAll() map[string]any

	Set(key string, value any) error
	Delete(key string) error

	SetToken(token string) error

	Clear() error

	SetTTL(ttl time.Duration)
	GetTTL() time.Duration
}

SessionStorageInstance defines a public type of API.

SessionMeta

Declaration:

gox

type SessionMeta struct {
	ID        string
	Token     string
	TTL       time.Duration
	ExpireAt  time.Time
	CreatedAt time.Time
	UpdatedAt time.Time
}

SessionMeta defines a public type of API.

Fields

Field	Type	Description
`ID`	`string`	Unique identifier.
`Token`	`string`	Token associate.
`TTL`	`time.Duration`	Life time.
`ExpireAt`	`time.Time`	Time mark.
`CreatedAt`	`time.Time`	Time mark.
`UpdatedAt`	`time.Time`	Time mark.

SessionExpireFunc

Declaration:

gox

type SessionExpireFunc func(session *ExpireSession)

SessionExpireFunc defines a public type of API.

SessionEventKind

Declaration:

gox

type SessionEventKind uint8

SessionEventKind defines a public type of API.

SessionEventExpired

Declaration:

gox

SessionEventExpired SessionEventKind = iota + 1

SessionEventExpired defines a constant value of the API.

SessionEventDestroyed

Declaration:

gox

SessionEventDestroyed

SessionEventDestroyed defines a constant value of the API.

SessionEvent

Declaration:

gox

type SessionEvent struct {
	Kind      SessionEventKind
	SessionID string
	Session   *ExpireSession
}

SessionEvent defines a public type of API.

Fields

Field	Type	Description
`Kind`	`SessionEventKind`	Event or state class.
`SessionID`	`string`	Associated identifier.
`Session`	`*ExpireSession`	Associated session.

SessionEventFunc

Declaration:

gox

type SessionEventFunc func(event SessionEvent)

SessionEventFunc defines a public type of API.

SessionRotateFunc

Declaration:

gox

type SessionRotateFunc func() (string, error)

SessionRotateFunc defines a public type of API.

SessionDestroyFunc

Declaration:

gox

type SessionDestroyFunc func() error

SessionDestroyFunc defines a public type of API.

SessionSaveFunc

Declaration:

gox

type SessionSaveFunc func() error

SessionSaveFunc defines a public type of API.

Session

Declaration:

gox

type Session struct {
	// contiene campos internos
}

Session defines a public type of API.

ExpireSession

Declaration:

gox

type ExpireSession struct {
	// contiene campos internos
}

ExpireSession defines a public type of API.

NewSession

Declaration:

gox

func NewSession(instance SessionStorageInstance) Session

Build NewSession.

Parameters

Parameter	Type	Description
`instance`	`SessionStorageInstance`	Type value `SessionStorageInstance` required by the operation.

Returns

Return	Type	Description
`value`	`Session`	Type value `Session` produced by the operation.

Usage syntax

gox

value := server.NewSession(value)

NewSessionReference

Declaration:

gox

func NewSessionReference(id string) Session

Build NewSessionReference.

Parameters

Parameter	Type	Description
`id`	`string`	Type value `string` required by the operation.

Returns

Return	Type	Description
`value`	`Session`	Type value `Session` produced by the operation.

Usage syntax

gox

value := server.NewSessionReference("id")

NewSessionWithRotate

Declaration:

gox

func NewSessionWithRotate(instance SessionStorageInstance, rotate SessionRotateFunc) Session

Build NewSessionWithRotate.

Parameters

Parameter	Type	Description
`instance`	`SessionStorageInstance`	Type value `SessionStorageInstance` required by the operation.
`rotate`	`SessionRotateFunc`	Type value `SessionRotateFunc` required by the operation.

Returns

Return	Type	Description
`value`	`Session`	Type value `Session` produced by the operation.

Usage syntax

gox

value := server.NewSessionWithRotate(value, value)

NewSessionWithLifecycle

Declaration:

gox

func NewSessionWithLifecycle(instance SessionStorageInstance, rotate SessionRotateFunc, destroy SessionDestroyFunc, onDestroyed func(), save ...SessionSaveFunc) Session

Build NewSessionWithLifecycle.

Parameters

Parameter	Type	Description
`instance`	`SessionStorageInstance`	Type value `SessionStorageInstance` required by the operation.
`rotate`	`SessionRotateFunc`	Type value `SessionRotateFunc` required by the operation.
`destroy`	`SessionDestroyFunc`	Type value `SessionDestroyFunc` required by the operation.
`onDestroyed`	`func()`	Type value `func()` required by the operation.
`save`	`...SessionSaveFunc`	Type value `...SessionSaveFunc` required by the operation.

Returns

Return	Type	Description
`value`	`Session`	Type value `Session` produced by the operation.

Usage syntax

gox

value := server.NewSessionWithLifecycle(value, value, value, nil, value)

DetachSession

Declaration:

gox

func DetachSession(session Session) Session

It creates a life-cycle session without callbacks.

Parameters

Parameter	Type	Description
`session`	`Session`	Type value `Session` required by the operation.

Returns

Return	Type	Description
`value`	`Session`	Type value `Session` produced by the operation.

Usage syntax

gox

value := server.DetachSession(value)

Session.ID

Declaration:

gox

func (s *Session) ID() string

Return the identifier.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := ctx.Session.ID()

Session.Token

Declaration:

gox

func (s *Session) Token() string

Give back the session token.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := ctx.Session.Token()

Session.Destroy

Declaration:

gox

func (s *Session) Destroy() error

Destroy the session and block new mutations.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

Destroy returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Destroy()

Session.IsDestroyed

Declaration:

gox

func (s *Session) IsDestroyed() bool

Indicates the state of IsDestroyed.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.

Usage syntax

gox

value := ctx.Session.IsDestroyed()

NewExpireSession

Declaration:

gox

func NewExpireSession(meta *SessionMeta, instance SessionStorageInstance) ExpireSession

Build NewExpireSession.

Parameters

Parameter	Type	Description
`meta`	`*SessionMeta`	Type value `*SessionMeta` required by the operation.
`instance`	`SessionStorageInstance`	Type value `SessionStorageInstance` required by the operation.

Returns

Return	Type	Description
`value`	`ExpireSession`	Type value `ExpireSession` produced by the operation.

Usage syntax

gox

value := server.NewExpireSession(nil, value)

ExpireSession.ID

Declaration:

gox

func (s *ExpireSession) ID() string

Return the identifier.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := expireSession.ID()

ExpireSession.Token

Declaration:

gox

func (s *ExpireSession) Token() string

Give back the session token.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := expireSession.Token()

ExpireSession.CreatedAt

Declaration:

gox

func (s *ExpireSession) CreatedAt() time.Time

Crea CreatedAt.

Returns

Return	Type	Description
`value`	`time.Time`	Type value `time.Time` produced by the operation.

Usage syntax

gox

value := expireSession.CreatedAt()

ExpireSession.LastUpdate

Declaration:

gox

func (s *ExpireSession) LastUpdate() time.Time

Returns the instant of the latest update.

Returns

Return	Type	Description
`value`	`time.Time`	Type value `time.Time` produced by the operation.

Usage syntax

gox

value := expireSession.LastUpdate()

ExpireSession.ExpireAt

Declaration:

gox

func (s *ExpireSession) ExpireAt() time.Time

It returns the moment of expiry.

Returns

Return	Type	Description
`value`	`time.Time`	Type value `time.Time` produced by the operation.

Usage syntax

gox

value := expireSession.ExpireAt()

ExpireSession.Get

Declaration:

gox

func (s *ExpireSession) Get(key string, out any) (bool, error)

It gets the first value associated with a key.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.
`out`	`any`	Destination where the result is decoded.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

When the key does not exist, it returns the zero value of T and false.

Errors

Get returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

value, err := expireSession.Get("key", &value)

ExpireSession.Has

Declaration:

gox

func (s *ExpireSession) Has(key string) bool

It indicates whether the collection contains the key.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.

Usage syntax

gox

value := expireSession.Has("key")

ExpireSession.GetAll

Declaration:

gox

func (s *ExpireSession) GetAll() map[string]any

It gets all the values associated with a key.

Returns

Return	Type	Description
`value`	`map[string]any`	Type value `map[string]any` produced by the operation.

Behavior

The returned slice is independent of the collection. When the key does not exist, it returns nil and false.

Usage syntax

gox

value := expireSession.GetAll()

ExpireSession.GetTTL

Declaration:

gox

func (s *ExpireSession) GetTTL() time.Duration

Get it. GetTTL.

Returns

Return	Type	Description
`value`	`time.Duration`	Type value `time.Duration` produced by the operation.

Usage syntax

gox

value := expireSession.GetTTL()

Session.Get

Declaration:

gox

func (s *Session) Get(key string, out any) (bool, error)

It gets the first value associated with a key.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.
`out`	`any`	Destination where the result is decoded.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

When the key does not exist, it returns the zero value of T and false.

Errors

Get returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

value, err := ctx.Session.Get("key", &value)

Session.Set

Declaration:

gox

func (s *Session) Set(key string, value any) error

Set or replace a value.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.
`value`	`any`	Value to be stored or issued.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

Replace the values previously associated with the same key.

Errors

Set returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Set("key", value)

Session.Has

Declaration:

gox

func (s *Session) Has(key string) bool

It indicates whether the collection contains the key.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.

Returns

Return	Type	Description
`value`	`bool`	It indicates the result of the check.

Usage syntax

gox

value := ctx.Session.Has("key")

Session.GetAll

Declaration:

gox

func (s *Session) GetAll() map[string]any

It gets all the values associated with a key.

Returns

Return	Type	Description
`value`	`map[string]any`	Type value `map[string]any` produced by the operation.

Behavior

The returned slice is independent of the collection. When the key does not exist, it returns nil and false.

Usage syntax

gox

value := ctx.Session.GetAll()

Session.Delete

Declaration:

gox

func (s *Session) Delete(key string) error

Eliminates the value associated with a key.

Parameters

Parameter	Type	Description
`key`	`string`	Key that identifies the value.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

It has no effect when the key does not exist.

Errors

Delete returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Delete("key")

Session.Rotate

Declaration:

gox

func (s *Session) Rotate() error

Rota Rotate.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

Rotate returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Rotate()

Session.Clear

Declaration:

gox

func (s *Session) Clear() error

Clean Clear.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

Clear returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Clear()

Session.Save

Declaration:

gox

func (s *Session) Save() error

The remaining changes remain.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

Save returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := ctx.Session.Save()

Session.SetTTL

Declaration:

gox

func (s *Session) SetTTL(ttl time.Duration)

Sets SetTTL.

Parameters

Parameter	Type	Description
`ttl`	`time.Duration`	Life time.

Usage syntax

gox

ctx.Session.SetTTL(time.Hour)

Session.GetTTL

Declaration:

gox

func (s *Session) GetTTL() time.Duration

Get it. GetTTL.

Returns

Return	Type	Description
`value`	`time.Duration`	Type value `time.Duration` produced by the operation.

Usage syntax

gox

value := ctx.Session.GetTTL()

MemorySessionAdapter

Declaration:

gox

type MemorySessionAdapter struct{}

MemorySessionAdapter defines a public type of API.

NewMemorySessionAdapter

Declaration:

gox

func NewMemorySessionAdapter() SessionStorage

Build NewMemorySessionAdapter.

Returns

Return	Type	Description
`value`	`SessionStorage`	Type value `SessionStorage` produced by the operation.

Usage syntax

gox

value := server.NewMemorySessionAdapter()

MemorySessionStorage

Declaration:

gox

func MemorySessionStorage() SessionStorage

Returns the session storage in memory.

Returns

Return	Type	Description
`value`	`SessionStorage`	Type value `SessionStorage` produced by the operation.

Usage syntax

gox

value := server.MemorySessionStorage()

MemorySessionAdapter.GetName

Declaration:

gox

func (MemorySessionAdapter) GetName() string

Get it. GetName.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := memorySessionAdapter.GetName()

MemorySessionAdapter.OpenSessionStorage

Declaration:

gox

func (MemorySessionAdapter) OpenSessionStorage(ctx context.Context, config SessionStorageConfig) (SessionStorageRuntime, error)

Open up. OpenSessionStorage.

Parameters

Parameter	Type	Description
`ctx`	`context.Context`	Context of execution.
`config`	`SessionStorageConfig`	Type value `SessionStorageConfig` required by the operation.

Returns

Return	Type	Description
`value`	`SessionStorageRuntime`	Type value `SessionStorageRuntime` produced by the operation.
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

OpenSessionStorage returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

value, err := memorySessionAdapter.OpenSessionStorage(ctx, value)

SessionTrace

Declaration:

gox

type SessionTrace struct {
	Enabled bool
}

SessionTrace defines a public type of API.

Fields

Field	Type	Description
`Enabled`	`bool`	Activate or disable the function.

SessionTraceField

Declaration:

gox

type SessionTraceField struct {
	Name  string
	Value string
}

SessionTraceField defines a public type of API.

Fields

Field	Type	Description
`Name`	`string`	Name of the value.
`Value`	`string`	Value stored.

SessionTraceStage

Declaration:

gox

type SessionTraceStage struct {
	Name     string
	Duration time.Duration
}

SessionTraceStage defines a public type of API.

Fields

Field	Type	Description
`Name`	`string`	Name of the value.
`Duration`	`time.Duration`	Length recorded.

NewSessionTrace

Declaration:

gox

func NewSessionTrace(enabled bool) *SessionTrace

Build NewSessionTrace.

Parameters

Parameter	Type	Description
`enabled`	`bool`	Type value `bool` required by the operation.

Returns

Return	Type	Description
`value`	`*SessionTrace`	Type value `*SessionTrace` produced by the operation.

Usage syntax

gox

value := server.NewSessionTrace(value)

SessionTrace.Now

Declaration:

gox

func (t *SessionTrace) Now() time.Time

Returns the watch used by the track.

Returns

Return	Type	Description
`value`	`time.Time`	Type value `time.Time` produced by the operation.

Usage syntax

gox

value := sessionTrace.Now()

SessionTrace.Add

Declaration:

gox

func (t *SessionTrace) Add(name string, started time.Time)

Add Add.

Parameters

Parameter	Type	Description
`name`	`string`	Name assigned.
`started`	`time.Time`	Type value `time.Time` required by the operation.

Usage syntax

gox

sessionTrace.Add("name", value)

SessionTrace.AddDuration

Declaration:

gox

func (t *SessionTrace) AddDuration(name string, duration time.Duration)

Add AddDuration.

Parameters

Parameter	Type	Description
`name`	`string`	Name assigned.
`duration`	`time.Duration`	Type value `time.Duration` required by the operation.

Usage syntax

gox

sessionTrace.AddDuration("name", value)

SessionTrace.AddField

Declaration:

gox

func (t *SessionTrace) AddField(name string, value string)

Add AddField.

Parameters

Parameter	Type	Description
`name`	`string`	Name assigned.
`value`	`string`	Value to be stored or issued.

Usage syntax

gox

sessionTrace.AddField("name", value)

SessionTrace.AddBool

Declaration:

gox

func (t *SessionTrace) AddBool(name string, value bool)

Add AddBool.

Parameters

Parameter	Type	Description
`name`	`string`	Name assigned.
`value`	`bool`	Value to be stored or issued.

Usage syntax

gox

sessionTrace.AddBool("name", value)

SessionTrace.Fields

Declaration:

gox

func (t *SessionTrace) Fields() []SessionTraceField

Give back a copy of the trace fields.

Returns

Return	Type	Description
`value`	`[]SessionTraceField`	Result collection; can be `nil` when there are no values.

Usage syntax

gox

value := sessionTrace.Fields()

SessionTrace.Stages

Declaration:

gox

func (t *SessionTrace) Stages() []SessionTraceStage

Returns a copy of the tracks.

Returns

Return	Type	Description
`value`	`[]SessionTraceStage`	Result collection; can be `nil` when there are no values.

Usage syntax

gox

value := sessionTrace.Stages()

Next step

Continue with cluster contracts.

Cluster