Help us shape the future of Go! Take the 2026 Go Developer Survey

link

package
v2.4.4 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2025 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BroadcastArgs 

type BroadcastArgs = cluster.BroadcastArgs

type DeliverArgs 

type DeliverArgs struct {
	NID    string // 接收节点。存在接收节点时，消息会直接投递给接收节点；不存在接收节点时，系统定位用户所在节点，然后投递。
	CID    int64  // 连接ID
	UID    int64  // 用户ID
	Route  int32  // 消息路由
	Buffer any    // 投递消息
}

type DisconnectArgs 

type DisconnectArgs = cluster.DisconnectArgs

type GateLinker 

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

func NewGateLinker 

func NewGateLinker(ctx context.Context, opts *Options) *GateLinker

func (*GateLinker) Ask 

func (l *GateLinker) Ask(ctx context.Context, gid string, uid int64) (string, bool, error)

Ask 检测用户是否在给定的网关上

func (*GateLinker) Bind 

func (l *GateLinker) Bind(ctx context.Context, gid string, cid, uid int64) error

Bind 绑定网关

func (*GateLinker) Broadcast 

func (l *GateLinker) Broadcast(ctx context.Context, args *BroadcastArgs) error

Broadcast 推送广播消息

func (*GateLinker) Disconnect 

func (l *GateLinker) Disconnect(ctx context.Context, args *DisconnectArgs) error

Disconnect 断开连接

func (*GateLinker) FetchGateList 

func (l *GateLinker) FetchGateList(ctx context.Context, states ...cluster.State) ([]*registry.ServiceInstance, error)

FetchGateList 拉取网关列表

func (*GateLinker) GetIP 

func (l *GateLinker) GetIP(ctx context.Context, args *GetIPArgs) (string, error)

GetIP 获取客户端IP

func (*GateLinker) GetState 

func (l *GateLinker) GetState(ctx context.Context, gid string) (cluster.State, error)

GetState 获取网关状态

func (*GateLinker) Has 

func (l *GateLinker) Has(gid string) bool

Has 检测是否存在某个网关

func (*GateLinker) IsOnline 

func (l *GateLinker) IsOnline(ctx context.Context, args *IsOnlineArgs) (bool, error)

IsOnline 检测是否在线

func (*GateLinker) Locate 

func (l *GateLinker) Locate(ctx context.Context, uid int64) (string, error)

Locate 定位用户所在网关

func (*GateLinker) Multicast 

func (l *GateLinker) Multicast(ctx context.Context, args *MulticastArgs) error

Multicast 推送组播消息

func (*GateLinker) PackBuffer 

func (l *GateLinker) PackBuffer(message any, encrypt bool) ([]byte, error)

PackBuffer 消息转buffer

func (*GateLinker) PackMessage 

func (l *GateLinker) PackMessage(message *Message, encrypt bool) (*buffer.NocopyBuffer, error)

PackMessage 打包消息

func (*GateLinker) Publish added in v2.3.1 

func (l *GateLinker) Publish(ctx context.Context, args *PublishArgs) error

Publish 发布频道消息

func (*GateLinker) Push 

func (l *GateLinker) Push(ctx context.Context, args *PushArgs) error

Push 推送消息

func (*GateLinker) SetState 

func (l *GateLinker) SetState(ctx context.Context, gid string, state cluster.State) error

SetState 设置网关状态

func (*GateLinker) Stat 

func (l *GateLinker) Stat(ctx context.Context, kind session.Kind) (int64, error)

Stat 统计会话总数

func (*GateLinker) Subscribe added in v2.3.1 

func (l *GateLinker) Subscribe(ctx context.Context, args *SubscribeArgs) error

Subscribe 订阅频道

func (*GateLinker) Unbind 

func (l *GateLinker) Unbind(ctx context.Context, uid int64) error

Unbind 解绑网关

func (*GateLinker) Unsubscribe added in v2.3.1 

func (l *GateLinker) Unsubscribe(ctx context.Context, args *UnsubscribeArgs) error

Unsubscribe 取消订阅频道

func (*GateLinker) WatchClusterInstance 

func (l *GateLinker) WatchClusterInstance()

WatchClusterInstance 监听集群实例

func (*GateLinker) WatchUserLocate 

func (l *GateLinker) WatchUserLocate()

WatchUserLocate 监听用户定位

type GetIPArgs 

type GetIPArgs = cluster.GetIPArgs

type IsOnlineArgs 

type IsOnlineArgs = cluster.IsOnlineArgs

type Message 

type Message = cluster.Message

type MulticastArgs 

type MulticastArgs = cluster.MulticastArgs

type NodeLinker 

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

func NewNodeLinker 

func NewNodeLinker(ctx context.Context, opts *Options) *NodeLinker

func (*NodeLinker) Ask 

func (l *NodeLinker) Ask(ctx context.Context, uid int64, name, nid string) (string, bool, error)

Ask 检测用户是否在给定的节点上

func (*NodeLinker) Bind 

func (l *NodeLinker) Bind(ctx context.Context, uid int64, name, nid string) error

Bind 绑定节点 单个用户可以绑定到多个节点服务器上，相同名称的节点服务器只能绑定一个，多次绑定会到相同名称的节点服务器会覆盖之前的绑定。 绑定操作会通过发布订阅方式同步到网关服务器和其他相关节点服务器上。

func (*NodeLinker) Deliver 

func (l *NodeLinker) Deliver(ctx context.Context, args *DeliverArgs) error

Deliver 投递消息给节点处理

func (*NodeLinker) FetchNodeList 

func (l *NodeLinker) FetchNodeList(ctx context.Context, states ...cluster.State) ([]*registry.ServiceInstance, error)

FetchNodeList 拉取节点列表

func (*NodeLinker) GetState 

func (l *NodeLinker) GetState(ctx context.Context, nid string) (cluster.State, error)

GetState 获取节点状态

func (*NodeLinker) Has 

func (l *NodeLinker) Has(nid string) bool

Has 检测是否存在某个节点

func (*NodeLinker) Locate 

func (l *NodeLinker) Locate(ctx context.Context, uid int64, name string) (string, error)

Locate 定位用户所在节点

func (*NodeLinker) PackBuffer added in v2.4.1 

func (l *NodeLinker) PackBuffer(message any, encrypt bool) ([]byte, error)

消息转buffer

func (*NodeLinker) PackMessage added in v2.4.1 

func (l *NodeLinker) PackMessage(message *Message, encrypt bool) (*buffer.NocopyBuffer, error)

打包消息

func (*NodeLinker) SetState 

func (l *NodeLinker) SetState(ctx context.Context, nid string, state cluster.State) error

SetState 设置节点状态

func (*NodeLinker) Trigger 

func (l *NodeLinker) Trigger(ctx context.Context, args *TriggerArgs) error

Trigger 触发事件

func (*NodeLinker) Unbind 

func (l *NodeLinker) Unbind(ctx context.Context, uid int64, name, nid string) error

Unbind 解绑节点 解绑时会对对应名称的节点服务器进行解绑，解绑时会对解绑节点ID进行校验，不匹配则解绑失败。 解绑操作会通过发布订阅方式同步到网关服务器和其他相关节点服务器上。

func (*NodeLinker) WatchClusterInstance 

func (l *NodeLinker) WatchClusterInstance()

WatchClusterInstance 监听集群实例

func (*NodeLinker) WatchUserLocate 

func (l *NodeLinker) WatchUserLocate()

WatchUserLocate 监听用户定位

type Options 

type Options struct {
	InsID     string            // 实例ID
	InsKind   cluster.Kind      // 实例类型
	Codec     encoding.Codec    // 编解码器
	Locator   locate.Locator    // 定位器
	Registry  registry.Registry // 注册器
	Encryptor crypto.Encryptor  // 加密器
	Dispatch  cluster.Dispatch  // 无状态路由消息分发策略
}

type PublishArgs added in v2.3.1 

type PublishArgs = cluster.PublishArgs

type PushArgs 

type PushArgs = cluster.PushArgs

type SubscribeArgs added in v2.3.1 

type SubscribeArgs = cluster.SubscribeArgs

type TriggerArgs 

type TriggerArgs struct {
	Event cluster.Event // 事件
	CID   int64         // 连接ID
	UID   int64         // 用户ID
}

type UnsubscribeArgs added in v2.3.1 

type UnsubscribeArgs = cluster.UnsubscribeArgs

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.