TsgcWSConnection

TsgcWSConnection 是客户端 WebSocket 连接的包装器。您可以在服务器或客户端事件中访问此对象。

 

方法

WriteData:向客户端发送消息。

 

关闭: 向对端发送关闭消息。可选指定"CloseCode"。默认情况下,发送的值为正常关闭代码。如果您发送负数关闭代码,则不会发送关闭原因。

 

Disconnect:从服务器端关闭客户端连接。可以选择指定"CloseCode"。

 

Ping:向客户端发送 ping。

 

AddTCPEndOfFrame:如果连接为普通 TCP,允许您设置定义消息结尾的字节。消息将被缓冲直到完整接收。

 

Subscribed:返回连接是否已订阅自定义频道。

 

Subscribe:将此连接订阅到频道。之后,您可以从服务器组件向订阅了该频道的所有连接广播消息。

 

UnSubscribe:取消订阅此连接的某个频道。

 

 

属性

Protocol:返回此连接使用的子协议。

 

IP: 返回对等方 IP 地址。

 

Port:返回对端端口。

 

LocalIP:返回主机 IP 地址。

 

LocalPort:返回主机端口。

 

URL:返回客户端请求的 URL。

 

Guid:返回连接 ID。

 

HeadersRequest:返回请求中收到的标头列表。

 

HeadersResponse:返回作为响应发送的标头列表。

 

RecBytes:已接收的字节数。

 

SendBytes:已发送的字节数。

 

Transport:返回连接的传输类型:

 

trpRFC6455:普通的 WebSocket 连接。

 

trpHixie76:使用草案 WebSocket 规范的 WebSocket 连接。

 

trpFlash:使用 Flash 作为回退的 WebSocket 连接。

 

trpSSE:服务器发送事件(SSE)连接。

 

trpTCP:普通 TCP 连接。

 

 

TCPEndOfFrameScanBuffer:允许定义用于查找消息结尾的方法(当使用 trpTCP 作为传输时)。

 

eofScanNone:每次有新数据包到达时,都会调用 OnBinary 事件。

 

eofScanLatestBytes:如果最新字节等于通过 AddTCPEndOfFrame 方法添加的字节,则调用 OnBinary 消息;否则缓冲此数据包

 

eofScanAllBytes:在整个数据包中搜索与 AddTCPEndOfFrame 方法添加的字节相等的字节。若找到,则调用 OnBinary 事件,否则对该数据包进行缓冲。

 

Data:用户会话数据对象,您可以在此处传入一个对象,并在每次需要时访问它,例如:您可以传入数据库连接、用户会话属性……