session

Documentation

Index

• Variables
• func NewSessionPool(config *config.Config) *sessionPoolImpl
• type Session
  • func (sess *Session) Close()
  • func (sess *Session) GetConnInfo() *acceptor.ConnInfo
  • func (sess *Session) GetData() SessionData
  • func (sess *Session) GetLastTimeOnline() int64
  • func (sess *Session) GetLatency() int64
  • func (sess *Session) GetOnCloseCallbacks() []func(id int64)
  • func (sess *Session) ID() int64
  • func (sess *Session) IsLogin() bool
  • func (sess *Session) OnClose(c func(id int64)) error
  • func (sess *Session) SendData(data []byte)
  • func (sess *Session) SendMessage(in interface{}, name ...string) error
  • func (sess *Session) SendPacket(data *packet.Packet)
  • func (sess *Session) SetOnCloseCallback(c func(id int64))
  • func (sess *Session) SetOnCloseCallbacks(callbacks []func(id int64))
  • func (sess *Session) SetUID(uid string)
  • func (sess *Session) UID() string
• type SessionData
• type SessionFilter
• type SessionMemory
  • func NewSessionMemory() *SessionMemory
  • func (sess *SessionMemory) Delete(key string)
  • func (sess *SessionMemory) Get(key string) (interface{}, bool)
  • func (sess *SessionMemory) GetData() map[string]interface{}
  • func (sess *SessionMemory) GetString(key, def string) string
  • func (sess *SessionMemory) Set(key string, value interface{})
• type SessionPool

Variables

var (
	ErrSessionNotFound = errors.New("session not found")
)

Functions

func NewSessionPool

func NewSessionPool(config *config.Config) *sessionPoolImpl

Types

type Session

type Session struct {
	OnCloseCallbacks []func(id int64) // close callback
	// contains filtered or unexported fields
}

func (*Session) Close

func (sess *Session) Close()

func (*Session) GetConnInfo

func (sess *Session) GetConnInfo() *acceptor.ConnInfo

func (*Session) GetData

func (sess *Session) GetData() SessionData

func (*Session) GetLastTimeOnline

func (sess *Session) GetLastTimeOnline() int64

func (*Session) GetLatency

func (sess *Session) GetLatency() int64

func (*Session) GetOnCloseCallbacks

func (sess *Session) GetOnCloseCallbacks() []func(id int64)

func (*Session) ID

func (sess *Session) ID() int64

func (*Session) IsLogin

func (sess *Session) IsLogin() bool

func (*Session) OnClose

func (sess *Session) OnClose(c func(id int64)) error

func (*Session) SendData

func (sess *Session) SendData(data []byte)

func (*Session) SendMessage

func (sess *Session) SendMessage(in interface{}, name ...string) error

func (*Session) SendPacket

func (sess *Session) SendPacket(data *packet.Packet)

func (*Session) SetOnCloseCallback

func (sess *Session) SetOnCloseCallback(c func(id int64))

func (*Session) SetOnCloseCallbacks

func (sess *Session) SetOnCloseCallbacks(callbacks []func(id int64))

func (*Session) SetUID

func (sess *Session) SetUID(uid string)

func (*Session) UID

func (sess *Session) UID() string

type SessionData

type SessionData interface {
	GetData() map[string]interface{}
	Set(key string, value interface{})
	Get(key string) (interface{}, bool)
	GetString(key, def string) string
	Delete(key string)
}

type SessionFilter

type SessionFilter struct {
	ConnType  string
	ConnName  string
	ConnGroup string
}

SessionFilter can filter the session from session list one user maybe has many session, so we can filter the session

type SessionMemory

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

func NewSessionMemory

func NewSessionMemory() *SessionMemory

func (*SessionMemory) Delete

func (sess *SessionMemory) Delete(key string)

func (*SessionMemory) Get

func (sess *SessionMemory) Get(key string) (interface{}, bool)

func (*SessionMemory) GetData

func (sess *SessionMemory) GetData() map[string]interface{}

GetData gets the data

func (*SessionMemory) GetString

func (sess *SessionMemory) GetString(key, def string) string

func (*SessionMemory) Set

func (sess *SessionMemory) Set(key string, value interface{})

Set associates value with the key in session storage

type SessionPool

type SessionPool interface {
	CreateSession(agent networkentity.NetworkEntity) *Session  // create session
	DeleteSession(id int64)                                    // delete session by id
	GetSessionCount() int64                                    // get current session count
	GetSessionTotalCount() int64                               // get total session count
	GetSessionByID(int64) (*Session, error)                    // get session by id
	GetSessionByUID(string, *SessionFilter) ([]int64, []int64) // get session by uid with filter
	ListSessions() []*Session                                  // list all session
	CloseAll()                                                 // close all session
}