server

package

Go to main page

Versions in this module

v1

v1.2.4

May 11, 2024

Changes in this version

type ChannelInfoReq

+ Disband int

type ChannelInfoResp

+ Disband int

type Varz

+ Goroutine int

v1.2.3

Apr 24, 2024

v1.2.2

Mar 25, 2024

v1.2.1

Mar 3, 2024

Changes in this version

type ConnManager

+ func (c *ConnManager) GetConnWithDeviceID(uid string, deviceID string) wknet.Conn

v1.2.0

Nov 23, 2023

Changes in this version

type Varz

+ RetryQueue int64

v1.1.9

Nov 20, 2023

Changes in this version

+ func GetHomeDir() (string, error)

type Server

+ func (s *Server) AddIPBlacklist(ips []string)

+ func (s *Server) AllowIP(ip string) bool

+ func (s *Server) RemoveIPBlacklist(ips []string)

+ type SystemAPI struct

+ func NewSystemAPI(s *Server) *SystemAPI

+ func (s *SystemAPI) Route(r *wkhttp.WKHttp)

v1.1.8

Oct 11, 2023

Changes in this version

type MessageResp

+ Expire uint32

type MessageSendReq

+ Expire uint32

type Options

+ func (o *Options) ConfigFileUsed() string

v1.1.7

Aug 7, 2023

Changes in this version

type Options

+ ManagerTokenOn bool

+ ManagerUID string

type Varz

+ ManagerTokenOn int

+ ManagerUID string

v1.1.6

Jul 11, 2023

Changes in this version

+ func GetFromUIDAndToUIDWith(channelID string) (string, string)

v1.1.5

Jul 10, 2023

v1.1.4

Jul 3, 2023

Changes in this version

type Message

+ func (m *Message) StreamIng() bool

+ func (m *Message) StreamStart() bool

type MessageResp

+ StreamFlag wkproto.StreamFlag

+ StreamNo string

+ StreamSeq uint32

+ Streams []*StreamItemResp

type MessageSendReq

+ StreamNo string

+ type StreamItemResp struct

+ Blob []byte

+ ClientMsgNo string

+ StreamSeq uint32

v1.1.3

Jun 29, 2023

Changes in this version

+ type DemoServer struct

+ func NewDemoServer(s *Server) *DemoServer

+ func (s *DemoServer) Start()

+ func (s *DemoServer) Stop()

type Options

+ Demo struct{ ... }

v1.1.2

Jun 26, 2023

v1.1.1

Jun 24, 2023

Changes in this version

type ChannelManager

+ func (cm *ChannelManager) GetOrCreateDataChannel(channelID string, channelType uint8) *Channel

+ func (cm *ChannelManager) RemoveDataChannel(channelID string, channelType uint8)

+ type FramePool struct

+ func NewFramePool() *FramePool

+ func (f *FramePool) GetRecvackPackets() []*wkproto.RecvackPacket

+ func (f *FramePool) GetSendPackets() []*wkproto.SendPacket

+ func (f *FramePool) GetSubPackets() []*wkproto.SubPacket

+ func (f *FramePool) GetSubackPackets() []*wkproto.SubackPacket

+ func (f *FramePool) PutRecvackPackets(recvackPackets []*wkproto.RecvackPacket)

+ func (f *FramePool) PutSendPackets(sendPackets []*wkproto.SendPacket)

+ func (f *FramePool) PutSubPackets(subPackets []*wkproto.SubPacket)

+ func (f *FramePool) PutSubackPackets(subackPackets []*wkproto.SubackPacket)

type Options

+ ManagerToken string

type Varz

+ APIURL string

+ func CreateVarz(s *Server) *Varz

v1.1.0

Jun 20, 2023

Changes in this version

type Options

+ WSSAddr string

+ WSSConfig struct{ ... }

+ WSTLSConfig *tls.Config

v1.0.9

Jun 18, 2023

Changes in this version

+ var ErrChannelNotFound = fmt.Errorf("channel not found")

+ var ErrParamInvalid = fmt.Errorf("param invalid")

type Options

+ SlotNum int

type Server

+ func (s *Server) GetConnInfos(sortOpt SortOpt, offset, limit int) []wknet.Conn

type SortOpt

+ const ByIDDesc

+ const ByInBytes

+ const ByInBytesDesc

+ const ByInMsg

+ const ByInMsgDesc

+ const ByOutBytes

+ const ByOutBytesDesc

+ const ByOutMsg

+ const ByOutMsgDesc

+ const ByPendingBytes

+ const ByPendingBytesDesc

+ const ByUptime

+ const ByUptimeDesc

type Varz

+ Conns []*ConnInfo

+ SlowClients int64

v1.0.8

Jun 13, 2023

v1.0.7

Jun 12, 2023

v1.0.6

Jun 10, 2023

v1.0.5

Jun 1, 2023

v1.0.4

May 30, 2023

Changes in this version

type Options

+ WSAddr string

type Varz

+ WSAddr string

v1.0.3

May 26, 2023

Changes in this version

type Options

+ GinMode string

+ RootDir string

type Varz

+ Commit string

+ CommitDate string

+ MonitorAddr string

+ MonitorOn int

+ TCPAddr string

+ TreeState string

+ WSSAddr string

+ WSSOn int

v1.0.2

May 25, 2023

v1.0.1

May 25, 2023

v1.0.0

May 24, 2023

Changes in this version

+ const EventMsgNotify

+ const EventMsgOffline

+ const EventOnlineStatus

+ var VERSION = "4.0.0"

+ func GetCommunityTopicParentChannelID(channelID string) string

+ func GetFakeChannelIDWith(fromUID, toUID string) string

+ func MarshalMessage(version uint8, m *Message) []byte

+ func UnmarshalMessage(data []byte, m *Message) error

+ type APIServer struct

+ func NewAPIServer(s *Server) *APIServer

+ func (s *APIServer) Start()

+ func (s *APIServer) Stop()

+ type Channel struct

+ func NewChannel(channelInfo *wkstore.ChannelInfo, s *Server) *Channel

+ func (c *Channel) AddAllowlist(uids []string)

+ func (c *Channel) AddDenylist(uids []string)

+ func (c *Channel) AddSubscriber(uid string)

+ func (c *Channel) AddSubscribers(uids []string)

+ func (c *Channel) AddTmpSubscriber(uid string)

+ func (c *Channel) AddTmpSubscribers(uids []string)

+ func (c *Channel) Allow(uid string) (bool, wkproto.ReasonCode)

+ func (c *Channel) GetAllSubscribers() []string

+ func (c *Channel) GetAllTmpSubscribers() []string

+ func (c *Channel) IsDenylist(uid string) bool

+ func (c *Channel) IsSubscriber(uid string) bool

+ func (c *Channel) IsTmpSubscriber(uid string) bool

+ func (c *Channel) LoadData() error

+ func (c *Channel) Put(messages []*Message, fromUID string, fromDeviceFlag wkproto.DeviceFlag, ...) error

+ func (c *Channel) RealSubscribers(customSubscribers []string) ([]string, error)

+ func (c *Channel) RemoveAllSubscriber()

+ func (c *Channel) RemoveAllTmpSubscriber()

+ func (c *Channel) RemoveAllowlist(uids []string)

+ func (c *Channel) RemoveDenylist(uids []string)

+ func (c *Channel) RemoveSubscriber(uid string)

+ func (c *Channel) RemoveSubscribers(uids []string)

+ func (c *Channel) RemoveTmSubscriber(uid string)

+ func (c *Channel) RemoveTmpSubscribers(uids []string)

+ func (c *Channel) SetAllowlist(uids []string)

+ func (c *Channel) SetDenylist(uids []string)

+ type ChannelAPI struct

+ func NewChannelAPI(s *Server) *ChannelAPI

+ func (ch *ChannelAPI) Route(r *wkhttp.WKHttp)

+ type ChannelCreateReq struct

+ Subscribers []string

+ func (r ChannelCreateReq) Check() error

+ type ChannelDeleteReq struct

+ ChannelID string

+ ChannelType uint8

+ type ChannelInfoReq struct

+ Ban int

+ ChannelID string

+ ChannelType uint8

+ Large int

+ func (c ChannelInfoReq) ToChannelInfo() *wkstore.ChannelInfo

+ type ChannelInfoResp struct

+ Ban int

+ Large int

+ func (c ChannelInfoResp) ToChannelInfo() *wkstore.ChannelInfo

+ type ChannelManager struct

+ func NewChannelManager(s *Server) *ChannelManager

+ func (cm *ChannelManager) CreateOrUpdatePersonChannel(uid string) error

+ func (cm *ChannelManager) CreateTmpChannel(channelID string, channelType uint8, subscribers []string) error

+ func (cm *ChannelManager) DeleteChannel(channelID string, channelType uint8) error

+ func (cm *ChannelManager) DeleteChannelFromCache(channelID string, channelType uint8)

+ func (cm *ChannelManager) GetChannel(channelID string, channelType uint8) (*Channel, error)

+ func (cm *ChannelManager) GetPersonChannel(channelID string, channelType uint8) (*Channel, error)

+ func (cm *ChannelManager) GetTmpChannel(channelID string, channelType uint8) (*Channel, error)

+ type ConnInfo struct

+ Device string

+ DeviceID string

+ ID int64

+ IP string

+ Idle string

+ InBytes int64

+ InMsgs int64

+ LastActivity time.Time

+ OutBytes int64

+ OutMsgs int64

+ PendingBytes int

+ Port int

+ UID string

+ Uptime string

+ Version uint8

+ type ConnManager struct

+ func NewConnManager(s *Server) *ConnManager

+ func (c *ConnManager) AddConn(conn wknet.Conn)

+ func (c *ConnManager) ExistConnsWithUID(uid string) bool

+ func (c *ConnManager) GetConn(id int64) wknet.Conn

+ func (c *ConnManager) GetConnCountWith(uid string, deviceFlag wkproto.DeviceFlag) (int, int)

+ func (c *ConnManager) GetConnsWith(uid string, deviceFlag wkproto.DeviceFlag) []wknet.Conn

+ func (c *ConnManager) GetConnsWithUID(uid string) []wknet.Conn

+ func (c *ConnManager) GetOnlineConns(uids []string) []wknet.Conn

+ func (c *ConnManager) RemoveConn(conn wknet.Conn)

+ func (c *ConnManager) RemoveConnWithID(id int64)

+ type Connz struct

+ Connections []*ConnInfo

+ Limit int

+ Now time.Time

+ Offset int

+ Total int

+ type ConnzAPI struct

+ func NewConnzAPI(s *Server) *ConnzAPI

+ func (co *ConnzAPI) HandleConnz(c *wkhttp.Context)

+ func (co *ConnzAPI) Route(r *wkhttp.WKHttp)

+ type ConversationAPI struct

+ func NewConversationAPI(s *Server) *ConversationAPI

+ func (s *ConversationAPI) Route(r *wkhttp.WKHttp)

+ type ConversationManager struct

+ func NewConversationManager(s *Server) *ConversationManager

+ func (cm *ConversationManager) AddOrUpdateConversation(uid string, conversation *wkstore.Conversation)

+ func (cm *ConversationManager) DeleteConversation(uids []string, channelID string, channelType uint8) error

+ func (cm *ConversationManager) FlushConversations()

+ func (cm *ConversationManager) GetConversation(uid string, channelID string, channelType uint8) *wkstore.Conversation

+ func (cm *ConversationManager) GetConversations(uid string, version int64, larges []*wkproto.Channel) []*wkstore.Conversation

+ func (cm *ConversationManager) PushMessage(message *Message, subscribers []string)

+ func (cm *ConversationManager) SetConversationUnread(uid string, channelID string, channelType uint8, unread int, messageSeq uint32) error

+ func (cm *ConversationManager) Start()

+ func (cm *ConversationManager) Stop()

+ type Datasource struct

+ func (d *Datasource) GetBlacklist(channelID string, channelType uint8) ([]string, error)

+ func (d *Datasource) GetChannelInfo(channelID string, channelType uint8) (*wkstore.ChannelInfo, error)

+ func (d *Datasource) GetSubscribers(channelID string, channelType uint8) ([]string, error)

+ func (d *Datasource) GetSystemUIDs() ([]string, error)

+ func (d *Datasource) GetWhitelist(channelID string, channelType uint8) ([]string, error)

+ type DeliveryManager struct

+ func NewDeliveryManager(s *Server) *DeliveryManager

+ type Dispatch struct

+ func NewDispatch(s *Server) *Dispatch

+ func (d *Dispatch) Start() error

+ func (d *Dispatch) Stop() error

+ type Event struct

+ Data interface{}

+ Event string

+ func (e *Event) String() string

+ type FrameWorkPool struct

+ func NewFrameWorkPool() *FrameWorkPool

+ func (f *FrameWorkPool) Submit(task func())

+ type IDatasource interface

+ GetBlacklist func(channelID string, channelType uint8) ([]string, error)

+ GetChannelInfo func(channelID string, channelType uint8) (*wkstore.ChannelInfo, error)

+ GetSubscribers func(channelID string, channelType uint8) ([]string, error)

+ GetSystemUIDs func() ([]string, error)

+ GetWhitelist func(channelID string, channelType uint8) ([]string, error)

+ func NewDatasource(s *Server) IDatasource

+ type Message struct

+ Subscribers []string

+ ToUID string

+ func (m *Message) Decode(msg []byte) error

+ func (m *Message) DeepCopy() (*Message, error)

+ func (m *Message) Encode() []byte

+ func (m *Message) GetMessageID() int64

+ func (m *Message) GetSeq() uint32

+ func (m *Message) SetSeq(seq uint32)

+ type MessageAPI struct

+ func NewMessageAPI(s *Server) *MessageAPI

+ func (m *MessageAPI) Route(r *wkhttp.WKHttp)

+ type MessageHeader struct

+ NoPersist int

+ RedDot int

+ SyncOnce int

+ type MessageOfflineNotify struct

+ Compress string

+ CompresssToUIDs []byte

+ SourceID int64

+ ToUIDs []string

+ type MessageResp struct

+ ChannelID string

+ ChannelType uint8

+ ClientMsgNo string

+ FromUID string

+ Header MessageHeader

+ MessageID int64

+ MessageIDStr string

+ MessageSeq uint32

+ Payload []byte

+ Setting uint8

+ Timestamp int32

+ Topic string

+ type MessageRespSlice []*MessageResp

+ func (m MessageRespSlice) Len() int

+ func (m MessageRespSlice) Less(i, j int) bool

+ func (m MessageRespSlice) Swap(i, j int)

+ type MessageSendReq struct

+ ChannelID string

+ ChannelType uint8

+ ClientMsgNo string

+ FromUID string

+ Header MessageHeader

+ Payload []byte

+ Subscribers []string

+ func (m MessageSendReq) Check() error

+ type Mode string

+ const BenchMode

+ const DebugMode

+ const ReleaseMode

+ const TestMode

+ type MonitorAPI struct

+ func NewMonitorAPI(s *Server) *MonitorAPI

+ func (m *MonitorAPI) Route(r *wkhttp.WKHttp)

+ type MonitorServer struct

+ func NewMonitorServer(s *Server) *MonitorServer

+ func (m *MonitorServer) Start()

+ func (m *MonitorServer) Stop() error

+ type OnlinestatusResp struct

+ DeviceFlag uint8

+ Online int

+ UID string

+ type Options struct

+ Addr string

+ Channel struct{ ... }

+ ConnIdleTime time.Duration

+ Conversation struct{ ... }

+ DataDir string

+ Datasource struct{ ... }

+ DeliveryMsgPoolSize int

+ EventPoolSize int

+ External struct{ ... }

+ HTTPAddr string

+ HandlePoolSize int

+ ID int64

+ Logger struct{ ... }

+ MessageRetry struct{ ... }

+ Mode Mode

+ Monitor struct{ ... }

+ Proto wkproto.Protocol

+ TimingWheelSize int64

+ TimingWheelTick time.Duration

+ TmpChannel struct{ ... }

+ TokenAuthOn bool

+ UnitTest bool

+ UserMsgQueueMaxSize int

+ Version string

+ WSS struct{ ... }

+ Webhook struct{ ... }

+ WhitelistOffOfPerson int

+ func NewOptions() *Options

+ func NewServerOptions() *Options

+ func NewTestOptions(logLevel ...zapcore.Level) *Options

+ func (o *Options) ConfigureWithViper(vp *viper.Viper)

+ func (o *Options) GetCustomerServiceVisitorUID(channelID string) (string, bool)

+ func (o *Options) HasDatasource() bool

+ func (o *Options) IsFakeChannel(channelID string) bool

+ func (o *Options) IsTmpChannel(channelID string) bool

+ func (o *Options) WebhookGRPCOn() bool

+ func (o *Options) WebhookOn() bool

+ type Processor struct

+ func NewProcessor(s *Server) *Processor

+ type PullMode int

+ const PullModeDown

+ const PullModeUp

+ type Queue struct

+ func NewQueue() *Queue

+ func (e *Queue) Close()

+ func (e *Queue) Len() int

+ func (e *Queue) Pop() (v interface{})

+ func (e *Queue) Push(v interface{})

+ func (e *Queue) TryPop() (v interface{}, ok bool)

+ func (e *Queue) Wait()

+ type RetryQueue struct

+ func NewRetryQueue(s *Server) *RetryQueue

+ func (r *RetryQueue) Start()

+ func (r *RetryQueue) Stop()

+ type RouteAPI struct

+ func NewRouteAPI(s *Server) *RouteAPI

+ func (a *RouteAPI) Route(r *wkhttp.WKHttp)

+ type Server struct

+ func New(opts *Options) *Server

+ func NewTestServer(ots ...*Options) *Server

+ func (s *Server) Init(env svc.Environment) error

+ func (s *Server) Schedule(interval time.Duration, f func()) *timingwheel.Timer

+ func (s *Server) Start() error

+ func (s *Server) Stop() error

+ type SortOpt string

+ const ByID

+ type SystemUIDManager struct

+ func NewSystemUIDManager(s *Server) *SystemUIDManager

+ func (s *SystemUIDManager) AddSystemUIDs(uids []string) error

+ func (s *SystemUIDManager) LoadIfNeed() error

+ func (s *SystemUIDManager) RemoveSystemUIDs(uids []string) error

+ func (s *SystemUIDManager) SystemUID(uid string) bool

+ type TestConn struct

+ func NewTestConn() *TestConn

+ func (t *TestConn) Authed() bool

+ func (t *TestConn) Close() error

+ func (t *TestConn) GetID() uint32

+ func (t *TestConn) OutboundBuffered() int

+ func (t *TestConn) RemoteAddr() net.Addr

+ func (t *TestConn) SetAuthed(v bool)

+ func (t *TestConn) SetID(id uint32)

+ func (t *TestConn) SetReadDeadline(tm time.Time) error

+ func (t *TestConn) SetVersion(version uint8)

+ func (t *TestConn) SetWriteDeadline(tm time.Time) error

+ func (t *TestConn) Version() uint8

+ func (t *TestConn) Write(buf []byte) (n int, err error)

+ func (t *TestConn) WriteChan() chan []byte

+ type UpdateTokenReq struct

+ DeviceFlag wkproto.DeviceFlag

+ DeviceLevel wkproto.DeviceLevel

+ Token string

+ UID string

+ func (u UpdateTokenReq) Check() error

+ type UserAPI struct

+ func NewUserAPI(s *Server) *UserAPI

+ func (u *UserAPI) Route(r *wkhttp.WKHttp)

+ type Varz struct

+ CPU float64

+ Connections int

+ InBytes int64

+ InMsgs int64

+ Mem int64

+ OutBytes int64

+ OutMsgs int64

+ ServerID string

+ ServerName string

+ SlowConsumers int64

+ Uptime string

+ Version string

+ type VarzAPI struct

+ func NewVarzAPI(s *Server) *VarzAPI

+ func (v *VarzAPI) HandleVarz(c *wkhttp.Context)

+ func (v *VarzAPI) Route(r *wkhttp.WKHttp)

+ type Webhook struct

+ func NewWebhook(s *Server) *Webhook

+ func (w *Webhook) Offline(uid string, deviceFlag wkproto.DeviceFlag, id int64, onlineCount int, ...)

+ func (w *Webhook) Online(uid string, deviceFlag wkproto.DeviceFlag, id int64, onlineCount int, ...)

+ func (w *Webhook) Start()

+ func (w *Webhook) Stop()

+ func (w *Webhook) TriggerEvent(event *Event)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL