im

package module

Go to main page

Versions in this module

v0

v0.3.7

Feb 29, 2024

v0.3.6

Jan 5, 2024

v0.3.5

Jan 5, 2024

Changes in this version

type Hub

+ func (hub *Hub) GetAppList() []string

v0.3.3

Jan 5, 2024

v0.3.2

Jan 5, 2024

Changes in this version

type Online

+ RemoteIp string

type Status

+ RemoteAddr string

v0.3.1

Jan 5, 2024

Changes in this version

+ const OfflineType

+ const OnlineType

+ var OfflineOpt = option.WithOpt(true, "im_offline", OfflineType)

+ var OnlineOpt = option.WithOpt(true, "im_offline", OnlineType)

type Online

+ ID int

v0.3.0

Jan 5, 2024

v0.2.25

Jan 5, 2024

v0.2.24

Jan 5, 2024

v0.2.23

Jan 5, 2024

v0.2.22

Jan 5, 2024

v0.2.21

Jan 5, 2024

Changes in this version

type Hub

+ func (hub *Hub) GetOnline(session *Session) *OnLineList

+ type OnLineList struct

+ Count int

+ List []*Online

type Online

+ func (u *Online) ToSession() Session

type Status

+ LoginTime int64

v0.2.20

Jan 5, 2024

Changes in this version

+ var EmptyByte = []byte("")

type Client

+ func (c *Client) Send(ctx context.Context, eventType EventType, body []byte) error

type Event

+ func CreateObjEvent(traceId string, evType EventType, content interface{}) *Event

v0.2.19

Jan 4, 2024

v0.2.18

Dec 30, 2023

v0.2.17

Dec 30, 2023

Changes in this version

+ type ClientConn interface

+ DoClientCmd func(ctx context.Context, cliCmd *ClientCmd)

+ DoClientCmdSync func(ctx context.Context, cliCmd *ClientCmd)

+ OnClose func(ctx context.Context)

+ OnLogin func(ctx context.Context, log *LogInfo)

+ OnLogout func(ctx context.Context, log *LogInfo)

+ Source func() string

+ StatusChanged func(ctx context.Context, us *Status)

+ type ConnectInfo struct

+ Reason string

+ RemoteIP string

+ Token string

+ Version string

type Hub

+ func (hub *Hub) OnClose(ctx context.Context)

v0.2.16

Dec 30, 2023

v0.2.15

Dec 30, 2023

Changes in this version

+ const EnableUserType

+ const HandshakeTimeoutType

type Option

+ func WithChatOption(chat chat.Chat) Option

+ func WithDiscoveryClientOption(client discoveryservice.Client) Option

v0.2.14

Dec 30, 2023

v0.2.13

Dec 30, 2023

Changes in this version

type Option

+ func WithWorkerNumOption(work int) Option

v0.2.12

Dec 30, 2023

v0.2.11

Dec 30, 2023

Changes in this version

+ const ETMq

+ const ETMqRsp

+ const IgnoreStatusBroadcast

+ const SendMQ

+ const SubscribeMQ

+ const UnSubscribeMQ

+ func IsMQEvent(ev int32) bool

type Client

+ func (c *Client) GetSource() string

+ func (c *Client) SendMQ(ctx context.Context, topic string, content string) error

+ func (c *Client) Subscribe(ctx context.Context, topic ...string) error

+ func (c *Client) UnSubscribe(ctx context.Context, topic ...string) error

+ type Hub struct

+ func NewHub(workMod int, opts ...Option) *Hub

+ func (hub *Hub) AddClients(client *Client)

+ func (hub *Hub) AddUsers(ctx context.Context, key string, client *Client, reason string) int

+ func (hub *Hub) Alarm(ctx context.Context, title, detail string, err error)

+ func (hub *Hub) CheckAllUserOnline(session *Session) bool

+ func (hub *Hub) CheckUserOnline(session *Session) bool

+ func (hub *Hub) ClientsRange(f func(client *Client) (result bool))

+ func (hub *Hub) DelClient(client *Client)

+ func (hub *Hub) DelUser(ctx context.Context, client *Client) bool

+ func (hub *Hub) DoClientCmd(ctx context.Context, reg *ClientCmd)

+ func (hub *Hub) DoClientCmdSync(ctx context.Context, cliCmd *ClientCmd)

+ func (hub *Hub) GetAllUserList(session *Session) *UserList

+ func (hub *Hub) GetClients() []*Client

+ func (hub *Hub) GetLocalUserList(session *Session) *UserList

+ func (hub *Hub) GetServerHost() string

+ func (hub *Hub) GetServerPort() int

+ func (hub *Hub) GetServers() []builder.Address

+ func (hub *Hub) GetUserClient(session *Session) *Client

+ func (hub *Hub) Handler(ctx context.Context, connect Connect, w http.ResponseWriter, r *http.Request) error

+ func (hub *Hub) InClient(client *Client) (ok bool)

+ func (hub *Hub) Init(cfg Config)

+ func (hub *Hub) IsLocalAddress(server string) bool

+ func (hub *Hub) OnLogin(ctx context.Context, log *LogInfo)

+ func (hub *Hub) OnLogout(ctx context.Context, log *LogInfo)

+ func (hub *Hub) RateLimit(session Session, version string) bool

+ func (hub *Hub) Receive(ctx context.Context, from *Session, to *Session, ev *Event) (err error)

+ func (hub *Hub) ReceiveAll(ctx context.Context, from *Session, to *Session, ev *Event) (err error)

+ func (hub *Hub) SendChat(ctx context.Context, from *Session, ev *Event, option chat.Option, ...) error

+ func (hub *Hub) SendToAllUser(ctx context.Context, from *Session, to *Session, ev *Event, data interface{})

+ func (hub *Hub) SendToLocalAppId(ctx context.Context, from *Session, to *Session, ev *Event, data interface{})

+ func (hub *Hub) SendToLocalUser(ctx context.Context, from *Session, to *Session, ev *Event) (error, bool)

+ func (hub *Hub) SendToRemote(ctx context.Context, from *Session, to *Session, ev *Event)

+ func (hub *Hub) SendToRemoteAppId(ctx context.Context, addr string, from *Session, to *Session, ev *Event)

+ func (hub *Hub) SendToRemoteUser(ctx context.Context, from *Session, to *Session, ev *Event) error

+ func (hub *Hub) SendToUser(ctx context.Context, from *Session, to *Session, ev *Event) error

+ func (hub *Hub) Source() string

+ func (hub *Hub) StatusChanged(ctx context.Context, us *Status)

+ func (hub *Hub) SyncToRemoteOnly(ctx context.Context, from *Session, to *Session, ev *Event)

+ func (hub *Hub) UnInit()

+ type MessageMQ struct

+ Cmd int

+ Content string

+ Topic string

+ type Mq struct

+ func (mq *Mq) Process(c *Client, req *EventReq) (interface{}, error)

+ func (mq *Mq) Receive(ctx context.Context, from *Session, ev *Event)

type Option

+ func WithChatGroupOption(chat chat.Group) Option

+ func WithDiscoveryClient(client discoveryservice.Client) Option

+ func WithGroupMgrOption() Option

+ func WithRpcClientOption(rpc rpc.Client) Option

+ func WithUseMQOption() Option

+ func WithUserMgrOption(user User) Option

type Session

+ Ignore int32

+ func (s *Session) IgnoreBit(f int32) bool

v0.2.10

Dec 15, 2023

v0.2.9

Dec 14, 2023

Changes in this version

+ func SdkVersion() string

v0.2.8

Dec 14, 2023

v0.2.7

Dec 14, 2023

v0.2.6

Dec 12, 2023

Changes in this version

type Config

+ AlarmFunc func(ctx context.Context, code int32, title, detail string, err error)

+ TokenCheckFunc func(ctx context.Context, client *Client, token string) error

v0.2.5

Dec 12, 2023

Changes in this version

+ func SetAlarmFunc(fn AlarmFunc)

+ type AlarmFunc func(ctx context.Context, code int32, title, detail string, err error)

v0.2.3

Dec 5, 2023

v0.2.2

Dec 4, 2023

Changes in this version

type Session

+ func (s *Session) Equal(c *Session) bool

+ func (s *Session) EqualAccount(c *Session) bool

+ func (s *Session) EqualAppId(session *Session) bool

+ func (s *Session) EqualPlat(session *Session) bool

+ func (s *Session) EqualUserId(c *Session) bool

v0.2.1

Dec 4, 2023

Changes in this version

+ type LogInfo struct

+ Client *Client

+ TimeAt int64

type Status

+ Addr string

v0.2.0

Dec 4, 2023

v0.1.30

Dec 4, 2023

Changes in this version

type Online

+ Account string

type Session

+ Account string

+ func (s *Session) IsValid() bool

v0.1.29

Dec 4, 2023

v0.1.28

Dec 4, 2023

Changes in this version

type Connect

+ Reason string

v0.1.27

Dec 3, 2023

Changes in this version

+ func IsEventResp(ev int32) bool

v0.1.26

Dec 3, 2023

Changes in this version

+ var Ignored = result.Error(-103, "ignore the error")

v0.1.25

Dec 3, 2023

v0.1.24

Dec 2, 2023

v0.1.23

Dec 2, 2023

Changes in this version

+ const CmdKick

type IM

+ func (im *IM) StatusChanged(ctx context.Context, us *UserStatus)

type Manager

+ StatusChanged func(ctx context.Context, us *UserStatus)

v0.1.22

Dec 2, 2023

Changes in this version

+ const CmdClose

+ const CmdRegister

+ const CmdUnRegister

+ func WithHandshakeTimeout(t time.Duration) option.Option

type Client

+ func BuildClient(im Manager, connect Connect, url string, index, firstTime int64, ...) *Client

+ func (c *Client) Close(ctx context.Context, reason string) error

+ func (c *Client) Run()

+ func (c *Client) WithDisposeFunc(fn DisposeFunc) *Client

+ type ClientCmd struct

+ Client *Client

+ Cmd int

+ Reason string

+ TraceId string

type IM

+ func (im *IM) DoClientCmd(ctx context.Context, reg *ClientCmd)

+ func (im *IM) DoClientCmdSync(ctx context.Context, reg *ClientCmd)

+ func (im *IM) Kicked(ctx context.Context, client *Client, reason string)

+ func (im *IM) OnLogin(ctx context.Context, log *UserLog)

+ func (im *IM) OnLogout(ctx context.Context, log *UserLog)

+ func (im *IM) Source() string

+ func (im *IM) UserStatusChanged(ctx context.Context, us *UserStatus)

+ type Manager interface

+ DoClientCmd func(ctx context.Context, reg *ClientCmd)

+ DoClientCmdSync func(ctx context.Context, reg *ClientCmd)

+ Kicked func(ctx context.Context, client *Client, reason string)

+ OnLogin func(ctx context.Context, log *UserLog)

+ OnLogout func(ctx context.Context, log *UserLog)

+ Source func() string

+ UserStatusChanged func(ctx context.Context, us *UserStatus)

+ type UserLog struct

+ Client *Client

+ Session Session

+ TimeAt int64

+ type UserStatus struct

+ Addr string

+ Session Session

+ Status int32

+ TimeAt int64

+ TraceId string

v0.1.21

Nov 30, 2023

v0.1.20

Nov 30, 2023

v0.1.19

Nov 30, 2023

v0.1.18

Nov 28, 2023

Changes in this version

+ func NewContext(ctx context.Context, traceId string) context.Context

v0.1.17

Nov 7, 2023

v0.1.16

Oct 25, 2023

v0.1.15

Oct 25, 2023

v0.1.14

Oct 20, 2023

v0.1.13

Oct 20, 2023

Changes in this version

type Connect

+ RemoteIP string

v0.1.12

Oct 10, 2023

Changes in this version

type Session

+ func (s *Session) IsSameAppId(session *Session) bool

+ func (s *Session) IsSamePlat(session *Session) bool

v0.1.11

Oct 9, 2023

v0.1.10

Oct 9, 2023

Changes in this version

type Client

+ func (c *Client) GetSession() Session

+ func (c *Client) GetToken() string

+ func (c *Client) Kick(ctx context.Context, reason string)

type Config

+ CheckFunc func(ctx context.Context, client *Client, token string) error

type Connect

+ Token string

type IM

+ func (im *IM) Alarm(ctx context.Context, detail string, err error)

v0.1.9

Sep 23, 2023

Changes in this version

+ func NewWithTraceId(traceId string) context.Context

+ func StringEvent(e int32) string

type Event

+ TraceId string

type EventReq

+ TraceId string

+ type MsgPack struct

+ Body []byte

+ TraceId string

type Status

+ TraceId string

v0.1.8

Jul 26, 2023

v0.1.7

Jul 26, 2023

Changes in this version

type Config

+ RegisterClient int

v0.1.6

Jul 26, 2023

v0.1.5

Jul 26, 2023

v0.1.4

Jul 22, 2023

v0.1.3

Jul 22, 2023

Changes in this version

+ var GrcClientNil = result.Error(-102, "not exist remote server")

+ var UserObjNil = result.Error(-101, "not exist remote server")

+ type Copy struct

+ Begin func(count int) interface{}

+ Process func(be interface{}, index int, data interface{})

v0.1.2

Jul 22, 2023

Changes in this version

+ const ETAppCall

+ const ETAppCallRsp

+ const ETCallListen

+ const ETCallListenRsp

+ const ETCallTransfer

+ const ETCallTransferRsp

+ const ETCallout

+ const ETCallout2

+ const ETCallout2Rsp

+ const ETCalloutRsp

+ const ETChat

+ const ETChatRsp

+ const ETClientBegin

+ const ETClientEnd

+ const ETClientHeartBeat

+ const ETClientHeartBeatRsp

+ const ETClientKicked

+ const ETClientLogin

+ const ETClientLoginRsp

+ const ETClientLogout

+ const ETClientLogoutRsp

+ const ETClientPing

+ const ETClientPingRsp

+ const ETClientUserList

+ const ETClientUserListRsp

+ const ETClientUserStatusChanged

+ const ETClientUserStatusChangedRes

+ const ETExServerBegin

+ const ETExServerEnd

+ const ETException

+ const ETHungUp

+ const ETHungUpRsp

+ const ETMessage

+ const ETMessageRsp

+ const ETNotify

+ const ETNotifyRsp

+ const ETServerBegin

+ const ETServerEnd

+ const StatusHeartbeat

+ const StatusOffline

+ const StatusOnline

+ const UserHeartbeatTimeout

+ var IAmNotMemberErr = errors.New("i am not member")

+ var KEmptyByte = []byte("")

+ var NotExistRemoteServer = result.Error(-100, "not exist remote server")

+ var StatusDesc = map[int32]string

+ func ContentQuote(d interface{}) string

+ func IsClientEvent(ev int32) bool

+ func IsExServerEvent(ev int32) bool

+ func IsServerEvent(ev int32) bool

+ func IsUserStatusChanged(ev int32) bool

+ func Register(key int32, value DisposeFunc)

+ func SessionToPBSession(session *Session, token string) *pb.Session

+ func SessionToPBUser(session *Session) *pb.User

+ func ToPBEvent(ev *Event) *pb.Event

+ type App struct

+ AppId string

+ Plat int32

+ type ArrayCopy struct

+ Begin func(count int) interface{}

+ Process func(be interface{}, index int, data interface{})

+ type Client struct

+ Addr string

+ ClientId uint64

+ Conn *websocket.Conn

+ ConnectId uint64

+ InUserList bool

+ Index int64

+ Token string

+ User Session

+ func NewClient(im *IM, addr string, conn *websocket.Conn, firstTime int64, connect Connect) *Client

+ func (c *Client) Heartbeat(currentTime int64)

+ func (c *Client) IsClosed() bool

+ func (c *Client) IsHeartbeatTimeout(currentTime int64) bool

+ func (c *Client) IsLogin() bool

+ func (c *Client) IsSameAppId(session *Session) bool

+ func (c *Client) IsSamePlat(session *Session) bool

+ func (c *Client) Login(user *Session, loginTime int64)

+ func (c *Client) Logout(logoutTime int64)

+ func (c *Client) SendTo(msg []byte) error

+ func (c *Client) SendToQueue(msg []byte) error

+ func (c *Client) String() string

+ type Config struct

+ ServerAddr server.Address

+ WorkForceReset bool

+ type Connect struct

+ Version string

+ type DisposeFunc func(client *Client, req *EventReq) (interface{}, error)

+ type Event struct

+ Content string

+ ContentType string

+ EvTypeBase int32

+ EventType int32

+ func CreateEvent(evType EventType, content []byte) *Event

+ func CreateEventWithContent(evType EventType, content interface{}) *Event

+ func PBEventTo(ev *pb.Event) *Event

+ type EventReq struct

+ EvTypeRsp int32

+ func Request(source string, user *Session) *EventReq

+ func RequestEvent(source string, ev *Event, user *Session) *EventReq

+ func (req *EventReq) ToBytes() []byte

+ func (req *EventReq) ToSession() *Session

+ type EventRes struct

+ func NewResponse(source string, head request.HeadV2, result result.Result, ev *Event) *EventRes

+ func NewResponseWithError(source string, head request.HeadV2, err error, ev *Event) *EventRes

+ type EventType int32

+ func (m EventType) Int() int32

+ type Group struct

+ AppId string

+ GId int64

+ Plat int32

+ func (g *Group) CheckMember(chatGroup chat.Group, from *Session) ([]chat.MemberId, bool)

+ func (g *Group) Enter(chatGroup chat.Group, user *chat.Member, option *chat.Option)

+ func (g *Group) Enters(chatGroup chat.Group, members []chat.Member, option *chat.Option)

+ func (g *Group) Leave(chatGroup chat.Group, userId chat.MemberId, option *chat.Option)

+ func (g *Group) Leaves(chatGroup chat.Group, members []chat.Member, option *chat.Option)

+ func (g *Group) Remove(chatGroup chat.Group, option *chat.Option)

+ func (g *Group) Send(chatGroup chat.Group, from *Session, amMemberFn IAmMemberFunc, fn MemberFunc) error

+ func (g *Group) String() string

+ func (g *Group) UpdateVersion(chatGroup chat.Group, option *chat.Option)

+ type GroupMgr struct

+ func NewGroupMgr() *GroupMgr

+ func (mgr *GroupMgr) CreateGroup(from *Session, group *chat.GroupModel, option *chat.Option) error

+ func (mgr *GroupMgr) DeleteGroup(from *Session, groupId int64, option *chat.Option) error

+ func (mgr *GroupMgr) GetGroup(groupKey string) (*Group, error)

+ func (mgr *GroupMgr) JoinGroup(from *Session, group *chat.GroupModel, option *chat.Option) error

+ func (mgr *GroupMgr) LeaveGroup(from *Session, group *chat.GroupModel, option *chat.Option) error

+ func (mgr *GroupMgr) OfflineGroups(from *Session)

+ func (mgr *GroupMgr) OnlineGroups(from *Session)

+ func (mgr *GroupMgr) Send(from *Session, chat *chat.Message, amMemberFn IAmMemberFunc, fn MemberFunc) error

+ func (mgr *GroupMgr) WithChatGroup(group chat.Group)

+ type IAmMemberFunc func(user *Session, iAmMember bool) error

+ type IM struct

+ func Inst() *IM

+ func NewIM() *IM

+ func (im *IM) AddClients(client *Client)

+ func (im *IM) AddUsers(key string, client *Client)

+ func (im *IM) CheckAllUserOnline(session *Session) bool

+ func (im *IM) CheckUserOnline(session *Session) bool

+ func (im *IM) ClearTimeoutConnections()

+ func (im *IM) ClientsRange(f func(client *Client) (result bool))

+ func (im *IM) DelClients(client *Client)

+ func (im *IM) DelUsers(client *Client) bool

+ func (im *IM) GetAllUserList(session *Session) *UserList

+ func (im *IM) GetClients() []*Client

+ func (im *IM) GetLocalUserList(session *Session) *UserList

+ func (im *IM) GetServerHost() string

+ func (im *IM) GetServerPort() int

+ func (im *IM) GetServers() []builder.Address

+ func (im *IM) GetUserClient(session *Session) *Client

+ func (im *IM) GrpcClient() rpc.IMClient

+ func (im *IM) Handler(connect Connect, w http.ResponseWriter, r *http.Request)

+ func (im *IM) InClient(client *Client) (ok bool)

+ func (im *IM) Init(client discoveryservice.Client, rpcClient rpc.IMClient, user User, ...)

+ func (im *IM) IsLocalAddress(server string) bool

+ func (im *IM) RateLimit(session Session, version string) bool

+ func (im *IM) ReceiveFromExServer(from *Session, to *Session, ev *Event, defHandler func())

+ func (im *IM) ReceiveToLocal(from *Session, to *Session, ev *Event)

+ func (im *IM) SendChat(from *Session, ev *Event, option chat.Option, handler func()) error

+ func (im *IM) SendToAllUser(from *Session, to *Session, ev *Event, custom interface{})

+ func (im *IM) SendToLocalAppId(from *Session, to *Session, ev *Event, custom interface{})

+ func (im *IM) SendToLocalUser(from *Session, to *Session, ev *Event) (error, bool)

+ func (im *IM) SendToRemote(from *Session, to *Session, ev *Event)

+ func (im *IM) SendToRemoteAppId(addr string, from *Session, to *Session, ev *Event)

+ func (im *IM) SendToRemoteUser(from *Session, to *Session, ev *Event) error

+ func (im *IM) SendToUser(from *Session, to *Session, ev *Event) error

+ func (im *IM) SyncToRemoteOnly(from *Session, to *Session, ev *Event)

+ func (im *IM) UnInit()

+ func (im *IM) UserMgr() User

+ func (im *IM) WithGroupModel(chat chat.Group) *IM

+ func (im *IM) WithGrpcClient(grpc rpc.IMClient) *IM

+ func (im *IM) WithUserMgr(user User) *IM

+ type MemberFunc func(groupId int64, user *Session) error

+ type Online struct

+ AppId string

+ ClientIp string

+ ClientPort string

+ HeartbeatTime int64

+ Host string

+ IsOffline bool

+ LogOutTime int64

+ LoginTime int64

+ Plat int32

+ Port int

+ UserId uint64

+ func (u *Online) Heartbeat(currentTime int64)

+ func (u *Online) IsLocal(localIp string, localPort int) bool

+ func (u *Online) IsOnline(heartCheck func(heartbeat int64) bool) bool

+ func (u *Online) LogIn(currentTime int64)

+ func (u *Online) LogOut(currentTime int64)

+ func (u *Online) String() string

+ type Option struct

+ CrmNotifyEnable bool

+ type ReqHead struct

+ RecvAt int64

+ ReqAt int64

+ SeqId string

+ Source string

+ TimeOut time.Duration

+ Version string

+ func (h *ReqHead) GetRecvAt() int64

+ func (h *ReqHead) GetReqAt() int64

+ func (h *ReqHead) GetSeqId() string

+ func (h *ReqHead) GetSource() string

+ func (h *ReqHead) GetTimeOut() time.Duration

+ func (h *ReqHead) GetVersion() string

+ func (h *ReqHead) SetSource(source string)

+ func (h *ReqHead) SetTimeOut(duration time.Duration)

+ type ResHead struct

+ DiffAt int64

+ LogId string

+ SeqId string

+ ServerAt int64

+ Source string

+ SpendAt int64

+ TimeAt int64

+ Version string

+ func NewResHead(source string, res result.Result) ResHead

+ type Session struct

+ AppId string

+ ClientId uint64

+ Plat int32

+ UserId uint64

+ func PBSessionToSession(session *pb.Session) Session

+ func PBUserToSession(u *pb.User) Session

+ func (s *Session) String() string

+ type Status struct

+ Desc string

+ Status int32

+ TimeAt int64

+ func (s *Status) String() string

+ type User interface

+ ExistSupportApp func(app App) bool

+ GetAllOnline func(cc *ArrayCopy, session *Session) error

+ GetUserKey func(session *Session) string

+ GetUserOnline func(session *Session) (*Online, error)

+ HeartbeatTimeout func() int64

+ IsUserOnline func(session *Session) (bool, error)

+ NextSupportApp func(fn func(app App) bool)

+ RemoveUserOnline func(session *Session) error

+ SetSupportApp func(apps []App)

+ SetUserOnline func(session *Session, online *Online) error

+ UserStatusChanged func(status *Status, option *Option)

+ type UserList struct

+ Count int

+ List []*Session

+ type Work struct

+ func (wk *Work) Add(client *Client)

+ func (wk *Work) Del(client *Client)

+ func (wk *Work) Send(local *localData)

+ func (wk *Work) Start()

+ func (wk *Work) Stop()

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