TsgcWSPServer_sgc › 事件

TsgcWSPServer_sgc 事件

可处理的事件按用途分组,后跟完整的字母顺序列表。

生命周期

名称描述
OnConnect客户端完成此子协议的 WebSocket 握手后触发。
OnDisconnect当客户端从服务器断开连接时触发。
OnError当子协议为连接报告协议级错误字符串时触发。
OnException当处理连接时发生未处理的异常时触发。

消息传递

名称描述
OnMessage当客户端在 sgc 信封中发送纯文本消息时触发。
OnBinary当客户端向服务器发送二进制帧时触发。
OnFragmented从客户端接收的每个分片 WebSocket 消息的分片触发一次。
OnRawMessage在文本消息解码之前触发,允许处理程序消费该消息。

PubSub

名称描述
OnBeforeSubscription在订阅被接受之前触发;处理程序可以拒绝或授权订阅。
OnSubscription客户端成功订阅频道后触发。
OnUnSubscription客户端取消订阅频道后触发。
OnBeforePublish在客户端发布被广播之前触发;处理器可重写或拒绝该发布。
OnNotification当客户端发送 JSON-RPC 通知(无 Id,无需回复)时触发。
OnAcknowledgment当客户端确认收到 QoS 级别 1 或级别 2 消息时触发。

RPC

名称描述
OnRPC当客户端在此服务器上调用 JSON-RPC 方法时触发。
OnRPCAuthentication当 RPC 方法不在允许列表中时触发,让处理程序对其进行授权。

所有事件(按字母顺序排列)

名称描述
OnAcknowledgment当客户端确认收到 QoS 级别 1 或级别 2 消息时触发。
OnBeforePublish在客户端发布被广播之前触发;处理器可重写或拒绝该发布。
OnBeforeSubscription在订阅被接受之前触发;处理程序可以拒绝或授权订阅。
OnBinary当客户端向服务器发送二进制帧时触发。
OnConnect客户端完成此子协议的 WebSocket 握手后触发。
OnDisconnect当客户端从服务器断开连接时触发。
OnError当子协议为连接报告协议级错误字符串时触发。
OnException当处理连接时发生未处理的异常时触发。
OnFragmented从客户端接收的每个分片 WebSocket 消息的分片触发一次。
OnMessage当客户端在 sgc 信封中发送纯文本消息时触发。
OnNotification当客户端发送 JSON-RPC 通知(无 Id,无需回复)时触发。
OnRawMessage在文本消息解码之前触发,允许处理程序消费该消息。
OnRPC当客户端在此服务器上调用 JSON-RPC 方法时触发。
OnRPCAuthentication当 RPC 方法不在允许列表中时触发,让处理程序对其进行授权。
OnSubscription客户端成功订阅频道后触发。
OnUnSubscription客户端取消订阅频道后触发。