Realm C++ SDK版本 v 2.2.0
公共成员函数 | 所有成员列表
域::networking::websocket_observer 结构引用摘要

#include <websocket.hpp>

公共成员函数

虚空 websocket_connected_handler (const std::string &protocol)= 0
 
虚空 websocket_error_handler ()= 0
 
虚拟布尔值 websocket_binary_message_received (std::string_view data)= 0
 
虚拟布尔值 websocket_close_handler (bool was_clean, websocket_err_codes error_code, std::string_view message)= 0
 

详细说明

Sync Client 中的 WebSocket 观察者接口,用于在操作期间接收 WebSocket 事件。

成员函数文档

websocket_binary_message_received()

虚拟 bool 域::networking::websocket_observer::websocket_binary_message_received ( std::string_view  数据)
纯虚拟

每当完整消息到达时调用。 WebSocket实施负责在内部对分片消息进行碎片整理,并将完整消息传递到同步客户端。

参数
数据包含从服务器接收到的数据的 util::Span。 缓冲区仅在函数返回之前有效。
返回:
bool 指定 WebSocket对象是否应继续处理消息。 正常返回值为 true 。 如果在函数执行期间 Websocket对象已被销毁,则必须返回 False。

websocket_close_handler()

virtual bool 域::networking::websocket_observer::websocket_close_handler ( bool  was_clean
websocket_err_codes  error_code,
std::string_view  message 
)
纯虚拟

每当 WebSocket 连接关闭时调用,无论是由于 WebSocket 错误还是正常关闭。

参数
was_cleanWebSocket 关闭握手完成后,TCP 连接是否已关闭。
error_code关闭 WebSocket 时收到或合成的错误代码。
message关闭 Websocket 时在关闭框架中收到的消息。
返回:
bool 指定 WebSocket对象是否已在此函数执行期间被销毁。 正常返回值为 True,表示 WebSocket对象不再有效。 如果返回 False,则 WebSocket对象将在将来的某个点被销毁。

websocket_connected_handler()

虚空域::networking::websocket_observer::websocket_connected_handler ( const std::string &  protocol)
纯虚拟

在连接 WebSocket 时(即握手完成后)调用。 在握手完成之前,不允许同步客户端在套接字上发送消息,并且在握手完成之前不会调用 message_received 回调。

参数
protocol服务器返回的协商子协议值

websocket_error_handler()

虚空域::networking::websocket_observer::websocket_error_handler ( )
纯虚拟

在建立与服务器的 WebSocket 连接时或正常操作期间发生错误时调用。 调用此函数后,将不再处理任何其他二进制消息。


该结构体的文档由以下文件生成: