WebSocketPeer

Inherits: PacketPeer < Reference < Object

类别： 核心

简要说明

表示特定WebSocket连接的类。

方法

无效

close ( int code=1000, String reason="" )

String

get_connected_host ( ) const

int

get_connected_port ( ) const

WriteMode

get_write_mode ( ) const

bool

is_connected_to_host ( ) const

无效

set_write_mode ( WriteMode mode )

bool

was_string_packet ( ) const

枚举

枚举 WriteMode ：

  • WRITE_MODE_TEXT = 0 ---指定WebSockets消息应作为文本负载传输（仅允许有效的UTF-8）。

  • WRITE_MODE_BINARY = 1 ---指定WebSockets消息应作为二进制负载传输（允许任何字节组合）。

描述

这个类表示一个特定的WebSocket连接，您可以用它执行较低级别的操作。

您可以选择以二进制或文本模式写入套接字，并且可以识别另一个对等方用于写入的模式。

方法说明

  • void close ( int code=1000, String reason="" )

关闭此WebSocket连接。 code 是关闭的状态代码（有关有效状态代码的列表，请参阅RFC 6455第7.4节）。 reason 是关闭连接的人可读原因（可以是小于123字节的任何utf-8字符串）。

注： 为了实现一个干净的结束，你需要保持投票直到 WebSocketClient.connection_closed 或 WebSocketServer.client_disconnected 收到。

注： HTML5导出可能不支持所有状态代码。有关详细信息，请参阅特定于浏览器的文档。

  • String get_connected_host ( ) const

返回已连接对等机的IP地址。

注： 在HTML5导出中不可用。

  • int get_connected_port ( ) const

返回已连接对等机的远程端口。

注： 在HTML5导出中不可用。

获取当前选定的写入模式。见 WriteMode .

  • bool is_connected_to_host ( ) const

返回 true 如果此对等机当前已连接。

将套接字设置为使用给定的 WriteMode .

  • bool was_string_packet ( ) const

返回 true 如果最后一个接收到的数据包作为文本负载发送。见 WriteMode