cherrySession

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2021 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NextSID added in v1.1.0 

func NextSID() facade.SID

Types

type Component added in v1.1.0 

type Component struct {
	sync.RWMutex
	facade.Component
	// contains filtered or unexported fields
}

Component session component

func NewComponent added in v1.1.0 

func NewComponent() *Component

func (*Component) AddOnClose added in v1.1.0 

func (s *Component) AddOnClose(listener ...SessionListener)

func (*Component) AddOnCreate added in v1.1.0 

func (s *Component) AddOnCreate(listener ...SessionListener)

func (*Component) Bind added in v1.1.0 

func (s *Component) Bind(sid facade.SID, uid facade.UID) error

func (*Component) CloseAll added in v1.1.0 

func (s *Component) CloseAll()

func (*Component) Create added in v1.1.0 

func (s *Component) Create(entity facade.INetwork) *Session

func (*Component) ForEachSIDSession added in v1.1.0 

func (s *Component) ForEachSIDSession(fn func(s *Session))

func (*Component) ForEachUIDSession added in v1.1.0 

func (s *Component) ForEachUIDSession(fn func(s *Session))

func (*Component) GetSessionCount added in v1.1.0 

func (s *Component) GetSessionCount() int

func (*Component) Import added in v1.1.0 

func (s *Component) Import(sid facade.SID, key string, value interface{}) error

func (*Component) ImportAll added in v1.1.0 

func (s *Component) ImportAll(sid facade.SID, settings map[string]interface{}) error

func (*Component) Kick added in v1.1.0 

func (s *Component) Kick(uid facade.UID) error

func (*Component) KickBySID added in v1.1.0 

func (s *Component) KickBySID(sid facade.SID) error

func (*Component) Name added in v1.1.0 

func (s *Component) Name() string

func (*Component) Unbind added in v1.1.0 

func (s *Component) Unbind(sid facade.SID)

type Group added in v1.1.0 

type Group struct {
	// contains filtered or unexported fields
}

Group represents a session group which used to manage a number of sessions, data send to the group will send to all session in it.

func NewGroup added in v1.1.0 

func NewGroup(n string) *Group

NewGroup returns a new group instance

func (*Group) Add added in v1.1.0 

func (c *Group) Add(session *Session) error

Add add session to group

func (*Group) Broadcast added in v1.1.0 

func (c *Group) Broadcast(route string, v interface{}) error

Broadcast push the message(s) to all members

func (*Group) Close added in v1.1.0 

func (c *Group) Close() error

Close destroy group, which will release all resource in the group

func (*Group) Contains added in v1.1.0 

func (c *Group) Contains(uid int64) bool

Contains check whether a UID is contained in current group or not

func (*Group) Count added in v1.1.0 

func (c *Group) Count() int

Count get current member amount in the group

func (*Group) Leave added in v1.1.0 

func (c *Group) Leave(s *Session) error

Leave remove specified UID related session from group

func (*Group) LeaveAll added in v1.1.0 

func (c *Group) LeaveAll() error

LeaveAll clear all sessions in the group

func (*Group) Member added in v1.1.0 

func (c *Group) Member(uid int64) (*Session, error)

Member returns specified UID's session

func (*Group) Members added in v1.1.0 

func (c *Group) Members() []int64

Members returns all member's UID in current group

func (*Group) Multicast added in v1.1.0 

func (c *Group) Multicast(route string, v interface{}, filter SessionFilter) error

Multicast push the message to the filtered clients

type IComponent added in v1.1.0 

type IComponent interface {
	Create(entity facade.INetwork) *Session
	Bind(sid facade.SID, uid facade.UID) error
	Unbind(sid facade.SID)
	CloseAll()
	AddOnCreate(listener ...SessionListener)
	AddOnClose(listener ...SessionListener)
}

type Session 

type Session struct {
	// contains filtered or unexported fields
}

func NewSession 

func NewSession(sid facade.SID, frontendId facade.FrontendId, entity facade.INetwork, component *Component) *Session

func (*Session) Bind 

func (s *Session) Bind(uid facade.UID) error

func (*Session) Clear added in v1.1.0 

func (s *Session) Clear()

Clear releases all settings related to current sc

func (*Session) Close added in v1.1.0 

func (s *Session) Close()

func (*Session) Contains added in v1.1.0 

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

func (*Session) Data added in v1.1.0 

func (s *Session) Data() map[string]interface{}

func (*Session) Debug added in v1.1.0 

func (s *Session) Debug(args ...interface{})

func (*Session) Debugf added in v1.1.0 

func (s *Session) Debugf(template string, args ...interface{})

func (*Session) Error added in v1.1.0 

func (s *Session) Error(args ...interface{})

func (*Session) Errorf added in v1.1.0 

func (s *Session) Errorf(template string, args ...interface{})

func (*Session) FrontendId 

func (s *Session) FrontendId() facade.FrontendId

func (*Session) GetFloat32 added in v1.1.0 

func (s *Session) GetFloat32(key string) float32

Float32 returns the value associated with the key as a float32.

func (*Session) GetFloat64 added in v1.1.0 

func (s *Session) GetFloat64(key string) float64

Float64 returns the value associated with the key as a float64.

func (*Session) GetInt added in v1.1.0 

func (s *Session) GetInt(key string) int

func (*Session) GetInt16 added in v1.1.0 

func (s *Session) GetInt16(key string) int16

Int16 returns the value associated with the key as a int16.

func (*Session) GetInt32 added in v1.1.0 

func (s *Session) GetInt32(key string) int32

Int32 returns the value associated with the key as a int32.

func (*Session) GetInt64 added in v1.1.0 

func (s *Session) GetInt64(key string) int64

Int64 returns the value associated with the key as a int64.

func (*Session) GetInt8 added in v1.1.0 

func (s *Session) GetInt8(key string) int8

Int8 returns the value associated with the key as a int8.

func (*Session) GetString added in v1.1.0 

func (s *Session) GetString(key string) string

String returns the value associated with the key as a string.

func (*Session) GetUint added in v1.1.0 

func (s *Session) GetUint(key string) uint

Uint returns the value associated with the key as a uint.

func (*Session) GetUint16 added in v1.1.0 

func (s *Session) GetUint16(key string) uint16

Uint16 returns the value associated with the key as a uint16.

func (*Session) GetUint32 added in v1.1.0 

func (s *Session) GetUint32(key string) uint32

Uint32 returns the value associated with the key as a uint32.

func (*Session) GetUint64 added in v1.1.0 

func (s *Session) GetUint64(key string) uint64

Uint64 returns the value associated with the key as a uint64.

func (*Session) GetUint8 added in v1.1.0 

func (s *Session) GetUint8(key string) uint8

Uint8 returns the value associated with the key as a uint8.

func (*Session) GetValue added in v1.1.0 

func (s *Session) GetValue(key string) interface{}

Value returns the value associated with the key as a interface{}.

func (*Session) Info added in v1.1.0 

func (s *Session) Info(args ...interface{})

func (*Session) Infof added in v1.1.0 

func (s *Session) Infof(template string, args ...interface{})

func (*Session) IsBind added in v1.1.0 

func (s *Session) IsBind() bool

func (*Session) Kick added in v1.1.0 

func (s *Session) Kick(reason string, close bool)

func (*Session) OnCloseProcess added in v1.1.0 

func (s *Session) OnCloseProcess()

func (*Session) Push added in v1.1.0 

func (s *Session) Push(route string, v interface{}) error

Push message to client

func (*Session) RPC added in v1.1.0 

func (s *Session) RPC(route string, v interface{}) error

RPC sends message to remote server

func (*Session) RemoteAddress added in v1.1.0 

func (s *Session) RemoteAddress() string

func (*Session) Remove added in v1.1.0 

func (s *Session) Remove(key string)

func (*Session) Response added in v1.1.0 

func (s *Session) Response(mid uint, v interface{}) error

Response responses message to client, mid is request message ID

func (*Session) Restore added in v1.1.0 

func (s *Session) Restore(data map[string]interface{})

func (*Session) SID 

func (s *Session) SID() facade.SID

func (*Session) SendRaw added in v1.1.0 

func (s *Session) SendRaw(bytes []byte) error

func (*Session) Set added in v1.1.0 

func (s *Session) Set(key string, value interface{})

func (*Session) String 

func (s *Session) String() string

func (*Session) UID 

func (s *Session) UID() facade.UID

func (*Session) Unbind added in v1.1.0 

func (s *Session) Unbind()

func (*Session) Warn added in v1.1.0 

func (s *Session) Warn(args ...interface{})

func (*Session) Warnf added in v1.1.0 

func (s *Session) Warnf(template string, args ...interface{})

type SessionFilter added in v1.1.0 

type SessionFilter func(*Session) bool

SessionFilter represents a filter which was used to filter session when Multicast, the session will receive the message while filter returns true.

type SessionListener added in v1.1.0 

type SessionListener func(session *Session) (next bool)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.