点击或拖拽改变大小

WebSocketServer 类

WebSocket协议的实现,支持创建自定义的websocket服务器,直接给其他的网页端,客户端,手机端发送数据信息,详细看api文档说明
The implementation of the WebSocket protocol supports the creation of custom websocket servers and sends data information directly to other web pages, clients, and mobile phones. See the API documentation for details.
继承层次
SystemObject
  HslCommunication.Core.NetNetworkBase
    HslCommunication.Core.NetNetworkXBase
      HslCommunication.Core.NetNetworkServerBase
        HslCommunication.WebSocketWebSocketServer

命名空间:  HslCommunication.WebSocket
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:9.1.3.0 (9.1.3.0)
语法
public class WebSocketServer : NetworkServerBase

WebSocketServer 类型公开以下成员。

构造函数
  名称说明
公共方法WebSocketServer
实例化一个默认的对象
Instantiate a default object
Top
属性
  名称说明
公共属性IsStarted
服务器引擎是否启动
Whether the server engine is started
(继承自 NetworkServerBase。)
公共属性IsTopicRetain
获取或设置当前的服务器是否对订阅主题信息缓存,方便订阅客户端立即收到结果,默认开启
Gets or sets whether the current server caches the topic information of the subscription, so that the subscription client can receive the results immediately. It is enabled by default.
公共属性KeepAlivePeriod
设置的参数,最小单位为1s,当超过设置的时间间隔必须回复PONG报文,否则服务器认定为掉线。默认120秒
Set the minimum unit of the parameter is 1s. When the set time interval is exceeded, the PONG packet must be returned, otherwise the server considers it to be offline. 120 seconds by default
公共属性KeepAliveSendInterval
获取或是设置用于保持连接的心跳时间的发送间隔。默认30秒钟,需要在服务启动之前设置
Gets or sets the sending interval of the heartbeat time used to keep the connection. 30 seconds by default, need to be set before the service starts
公共属性代码示例LogNet
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出
The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG
(继承自 NetworkBase。)
公共属性OnlineCount
获取当前的在线的客户端数量
Get the current number of online clients
公共属性OnlineSessions
获取当前的在线的客户端信息,可以用于额外的分析或是显示。
公共属性Port
获取或设置服务器的端口号,如果是设置,需要在服务器启动前设置完成,才能生效。
Gets or sets the port number of the server. If it is set, it needs to be set before the server starts to take effect.
(继承自 NetworkServerBase。)
公共属性代码示例Token
网络类的身份令牌,在hsl协议的模式下会有效,在和设备进行通信的时候是无效的
Network-type identity tokens will be valid in the hsl protocol mode and will not be valid when communicating with the device
(继承自 NetworkBase。)
Top
方法
  名称说明
公共方法AddSessionTopic
给一个当前的会话信息动态添加订阅的主题
Dynamically add subscribed topics to a current session message
受保护的方法AsyncAcceptCallback
异步传入的连接申请请求
Asynchronous incoming connection request
(继承自 NetworkServerBase。)
受保护的方法CheckRemoteToken
检查当前的头子节信息的令牌是否是正确的,仅用于某些特殊的协议实现
Check whether the token of the current header subsection information is correct, only for some special protocol implementations
(继承自 NetworkBase。)
受保护的方法CloseAction
服务器关闭的时候需要做的事情
Things to do when the server is down
(重写 NetworkServerBaseCloseAction.)
公共方法ConnectHslAlientClient
创建一个指定的异形客户端连接,使用Hsl协议来发送注册包
Create a specified profiled client connection and use the Hsl protocol to send registration packets
(继承自 NetworkServerBase。)
公共方法ConnectHslAlientClientAsync
创建一个指定的异形客户端连接,使用Hsl协议来发送注册包
Create a specified profiled client connection and use the Hsl protocol to send registration packets
(继承自 NetworkServerBase。)
受保护的方法代码示例CreateSocketAndConnect(IPEndPoint, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定远程终结点,超时时间(单位是毫秒)
To create a new socket object and connect to a remote address, you need to specify the remote endpoint and the timeout period (in milliseconds)
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnect(String, Int32)
创建一个新的socket对象并连接到远程的地址,默认超时时间为10秒钟,需要指定ip地址以及端口号信息
Create a new socket object and connect to the remote address. The default timeout is 10 seconds. You need to specify the IP address and port number.
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnect(String, Int32, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定ip地址以及端口号信息,还有超时时间,单位是毫秒
To create a new socket object and connect to a remote address, you need to specify the IP address and port number information, and the timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(IPEndPoint, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定远程终结点,超时时间(单位是毫秒)
To create a new socket object and connect to a remote address, you need to specify the remote endpoint and the timeout period (in milliseconds)
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(String, Int32)
创建一个新的socket对象并连接到远程的地址,默认超时时间为10秒钟,需要指定ip地址以及端口号信息
Create a new socket object and connect to the remote address. The default timeout is 10 seconds. You need to specify the IP address and port number.
(继承自 NetworkBase。)
受保护的方法代码示例CreateSocketAndConnectAsync(String, Int32, Int32)
创建一个新的socket对象并连接到远程的地址,需要指定ip地址以及端口号信息,还有超时时间,单位是毫秒
To create a new socket object and connect to a remote address, you need to specify the IP address and port number information, and the timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法DeleteFileByName
删除文件的操作
Delete file operation
(继承自 NetworkXBase。)
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
公共方法GetType
Gets the Type of the current instance.
(继承自 Object。)
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
受保护的方法PreprocessFolderName
预处理文件夹的名称,除去文件夹名称最后一个'\'或'/',如果有的话
Preprocess the name of the folder, removing the last '\' or '/' in the folder name
(继承自 NetworkXBase。)
公共方法PublishAllClientPayload
向所有的客户端强制发送消息
Force message to all clients
公共方法PublishClientPayload
向订阅了topic主题的客户端发送消息
Send messages to clients subscribed to topic
受保护的方法ReadStream
读取流中的数据到缓存区,读取的长度需要按照实际的情况来判断
Read the data in the stream to the buffer area. The length of the read needs to be determined according to the actual situation.
(继承自 NetworkBase。)
受保护的方法ReadStreamAsync
读取流中的数据到缓存区,读取的长度需要按照实际的情况来判断
Read the data in the stream to the buffer area. The length of the read needs to be determined according to the actual situation.
(继承自 NetworkBase。)
受保护的方法Receive
接收固定长度的字节数组,允许指定超时时间,默认为60秒,当length大于0时,接收固定长度的数据内容,当length小于0时,接收不大于1024长度的随机数据信息
Receiving a fixed-length byte array, allowing a specified timeout time. The default is 60 seconds. When length is greater than 0, fixed-length data content is received. When length is less than 0, random data information of a length not greater than 1024 is received.
(继承自 NetworkBase。)
受保护的方法ReceiveAndCheckBytes
[自校验] 接收一条完整的同步数据,包含头子节和内容字节,基础的数据,如果结果异常,则结束通讯
[Self-checking] Receive a complete synchronization data, including header subsection and content bytes, basic data, if the result is abnormal, the communication ends
(继承自 NetworkBase。)
受保护的方法ReceiveAndCheckBytesAsync
[自校验] 接收一条完整的同步数据,包含头子节和内容字节,基础的数据,如果结果异常,则结束通讯
[Self-checking] Receive a complete synchronization data, including header subsection and content bytes, basic data, if the result is abnormal, the communication ends
(继承自 NetworkBase。)
受保护的方法ReceiveAsync
接收固定长度的字节数组,允许指定超时时间,默认为60秒,当length大于0时,接收固定长度的数据内容,当length小于0时,接收不大于1024长度的随机数据信息
Receiving a fixed-length byte array, allowing a specified timeout time. The default is 60 seconds. When length is greater than 0, fixed-length data content is received. When length is less than 0, random data information of a length not greater than 1024 is received.
(继承自 NetworkBase。)
受保护的方法ReceiveByMessage
接收一条完整的 数据内容,需要指定超时时间,单位为毫秒。
Receive a complete data content, Need to specify a timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法ReceiveByMessageAsync
接收一条完整的 数据内容,需要指定超时时间,单位为毫秒。
Receive a complete data content, Need to specify a timeout period in milliseconds
(继承自 NetworkBase。)
受保护的方法ReceiveBytesContentFromSocket
[自校验] 从网络中接收一串字节数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of byte data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveBytesContentFromSocketAsync
[自校验] 从网络中接收一串字节数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of byte data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocket(Socket, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocket(Socket, Byte, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocketAsync(Socket, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveCommandLineFromSocketAsync(Socket, Byte, Byte, Int32)
接收一行命令数据,需要自己指定这个结束符,默认超时时间为60秒,也即是60000,单位是毫秒
To receive a line of command data, you need to specify the terminator yourself. The default timeout is 60 seconds, which is 60,000, in milliseconds.
(继承自 NetworkBase。)
受保护的方法ReceiveFileFromSocket(Socket, Stream, ActionInt64, Int64)
[自校验] 从网络中接收一个文件,写入数据流,如果结果异常,则结束通讯,参数顺序文件名,文件大小,文件标识,上传人
[Self-checking] Receive a file from the network. If the result is abnormal, the communication ends.
(继承自 NetworkXBase。)
受保护的方法ReceiveFileFromSocket(Socket, String, ActionInt64, Int64)
[自校验] 从网络中接收一个文件,如果结果异常,则结束通讯
[Self-checking] Receive a file from the network. If the result is abnormal, the communication ends.
(继承自 NetworkXBase。)
受保护的方法ReceiveFileFromSocketAsync(Socket, Stream, ActionInt64, Int64)
[自校验] 从网络中接收一个文件,写入数据流,如果结果异常,则结束通讯,参数顺序文件名,文件大小,文件标识,上传人
[Self-checking] Receive a file from the network. If the result is abnormal, the communication ends.
(继承自 NetworkXBase。)
受保护的方法ReceiveFileFromSocketAsync(Socket, String, ActionInt64, Int64)
[自校验] 从网络中接收一个文件,如果结果异常,则结束通讯
[Self-checking] Receive a file from the network. If the result is abnormal, the communication ends.
(继承自 NetworkXBase。)
受保护的方法ReceiveFileHeadFromSocket
[自校验] 从套接字中接收文件头信息
[Self-checking] Receive file header information from socket
(继承自 NetworkXBase。)
受保护的方法ReceiveFileHeadFromSocketAsync
[自校验] 从套接字中接收文件头信息
[Self-checking] Receive file header information from socket
(继承自 NetworkXBase。)
受保护的方法ReceiveFrameWebSocketPayload
从socket接收一条WebSocketMessage片段数据,返回WebSocketMessage的数据信息和是否最后一条数据内容
Receive a piece of WebSocketMessage fragment data from the socket, return the data information of WebSocketMessage and whether the last data content
(继承自 NetworkBase。)
受保护的方法ReceiveFrameWebSocketPayloadAsync
从socket接收一条WebSocketMessage片段数据,返回WebSocketMessage的数据信息和是否最后一条数据内容
Receive a piece of WebSocketMessage fragment data from the socket, return the data information of WebSocketMessage and whether the last data content
(继承自 NetworkBase。)
受保护的方法ReceiveHslMessage
接收一条hsl协议的数据信息,自动解析,解压,解码操作,获取最后的实际的数据,接收结果依次为暗号,用户码,负载数据
Receive a piece of hsl protocol data information, automatically parse, decompress, and decode operations to obtain the last actual data. The result is a opCode, user code, and payload data in order.
(继承自 NetworkXBase。)
受保护的方法ReceiveHslMessageAsync
接收一条hsl协议的数据信息,自动解析,解压,解码操作,获取最后的实际的数据,接收结果依次为暗号,用户码,负载数据
Receive a piece of hsl protocol data information, automatically parse, decompress, and decode operations to obtain the last actual data. The result is a opCode, user code, and payload data in order.
(继承自 NetworkXBase。)
受保护的方法ReceiveMqttMessage
接收一条完成的MQTT协议的报文信息,包含控制码和负载数据
Receive a message of a completed MQTT protocol, including control code and payload data
(继承自 NetworkBase。)
受保护的方法ReceiveMqttMessageAsync
接收一条完成的MQTT协议的报文信息,包含控制码和负载数据
Receive a message of a completed MQTT protocol, including control code and payload data
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommand
从网络接收一条完整的redis报文的消息
Receive a complete redis message from the network
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandAsync
从网络接收一条完整的redis报文的消息
Receive a complete redis message from the network
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandString
接收一行基于redis协议的字符串的信息,需要指定固定的长度
Receive a line of information based on the redis protocol string, you need to specify a fixed length
(继承自 NetworkBase。)
受保护的方法ReceiveRedisCommandStringAsync
接收一行基于redis协议的字符串的信息,需要指定固定的长度
Receive a line of information based on the redis protocol string, you need to specify a fixed length
(继承自 NetworkBase。)
受保护的方法ReceiveStringArrayContentFromSocket
[自校验] 从网络中接收一个字符串数组,如果结果异常,则结束通讯
[Self-check] Receive an array of strings from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringArrayContentFromSocketAsync
[自校验] 从网络中接收一个字符串数组,如果结果异常,则结束通讯
[Self-check] Receive an array of strings from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringContentFromSocket
[自校验] 从网络中接收一个字符串数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveStringContentFromSocketAsync
[自校验] 从网络中接收一个字符串数据,如果结果异常,则结束通讯
[Self-checking] Receive a string of data from the network. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法ReceiveWebSocketPayload
从socket接收一条完整的websocket数据,返回WebSocketMessage的数据信息
Receive a complete websocket data from the socket, return the data information of the WebSocketMessage
(继承自 NetworkBase。)
受保护的方法ReceiveWebSocketPayloadAsync
从socket接收一条完整的websocket数据,返回WebSocketMessage的数据信息
Receive a complete websocket data from the socket, return the data information of the WebSocketMessage
(继承自 NetworkBase。)
公共方法RemoveAndCloseSession
让Websocket客户端正常下线,调用本方法即可自由控制会话客户端强制下线操作。
Let the Websocket client go offline normally. Call this method to freely control the session client to force offline operation.
受保护的方法Send(Socket, Byte)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法Send(Socket, Byte, Int32, Int32)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendAccountAndCheckReceive
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendAccountAndCheckReceiveAsync
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendAsync(Socket, Byte)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendAsync(Socket, Byte, Int32, Int32)
发送消息给套接字,直到完成的时候返回,经过测试,本方法是线程安全的。
Send a message to the socket until it returns when completed. After testing, this method is thread-safe.
(继承自 NetworkBase。)
受保护的方法SendBaseAndCheckReceive
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBaseAndCheckReceiveAsync
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBytesAndCheckReceive
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendBytesAndCheckReceiveAsync
[自校验] 发送字节数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send the byte data and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
公共方法SendClientPayload
向指定的客户端发送数据
Send data to the specified client
受保护的方法SendFileAndCheckReceive(Socket, Stream, String, String, String, ActionInt64, Int64)
[自校验] 将流数据发送至套接字,具体发送细节将在继承类中实现,如果结果异常,则结束通讯
[Self-checking] Send stream data to the socket. The specific sending details will be implemented in the inherited class. If the result is abnormal, the communication will be terminated
(继承自 NetworkXBase。)
受保护的方法SendFileAndCheckReceive(Socket, String, String, String, String, ActionInt64, Int64)
[自校验] 将文件数据发送至套接字,具体发送细节将在继承类中实现,如果结果异常,则结束通讯
[Self-checking] Send the file data to the socket. The specific sending details will be implemented in the inherited class. If the result is abnormal, the communication will end
(继承自 NetworkXBase。)
受保护的方法SendFileAndCheckReceiveAsync(Socket, Stream, String, String, String, ActionInt64, Int64)
[自校验] 将流数据发送至套接字,具体发送细节将在继承类中实现,如果结果异常,则结束通讯
[Self-checking] Send stream data to the socket. The specific sending details will be implemented in the inherited class. If the result is abnormal, the communication will be terminated
(继承自 NetworkXBase。)
受保护的方法SendFileAndCheckReceiveAsync(Socket, String, String, String, String, ActionInt64, Int64)
[自校验] 将文件数据发送至套接字,具体发送细节将在继承类中实现,如果结果异常,则结束通讯
[Self-checking] Send the file data to the socket. The specific sending details will be implemented in the inherited class. If the result is abnormal, the communication will end
(继承自 NetworkXBase。)
受保护的方法SendFileStreamToSocket
[自校验] 将文件数据发送至套接字,如果结果异常,则结束通讯
[Self-check] Send the file data to the socket. If the result is abnormal, the communication is ended.
(继承自 NetworkXBase。)
受保护的方法SendFileStreamToSocketAsync
[自校验] 将文件数据发送至套接字,如果结果异常,则结束通讯
[Self-check] Send the file data to the socket. If the result is abnormal, the communication is ended.
(继承自 NetworkXBase。)
受保护的方法SendStreamToSocket
发送一个流的所有数据到指定的网络套接字,需要指定发送的数据长度,支持按照百分比的进度报告
Send all the data of a stream to the specified network socket. You need to specify the length of the data to be sent. It supports the progress report in percentage.
(继承自 NetworkBase。)
受保护的方法SendStreamToSocketAsync
发送一个流的所有数据到指定的网络套接字,需要指定发送的数据长度,支持按照百分比的进度报告
Send all the data of a stream to the specified network socket. You need to specify the length of the data to be sent. It supports the progress report in percentage.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceive(Socket, Int32, String)
[自校验] 直接发送字符串数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-checking] Send string data directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceive(Socket, Int32, String)
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceiveAsync(Socket, Int32, String)
[自校验] 直接发送字符串数据并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-checking] Send string data directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
受保护的方法SendStringAndCheckReceiveAsync(Socket, Int32, String)
[自校验] 直接发送字符串数组并确认对方接收完成数据,如果结果异常,则结束通讯
[Self-check] Send string array directly and confirm that the other party has received the completed data. If the result is abnormal, the communication ends.
(继承自 NetworkBase。)
公共方法ServerClose
关闭服务器的引擎
Shut down the server's engine
(继承自 NetworkServerBase。)
公共方法ServerStart
使用已经配置好的端口启动服务器的引擎
Use the configured port to start the server's engine
(继承自 NetworkServerBase。)
公共方法ServerStart(Int32)
指定端口号来启动服务器的引擎
Specify the port number to start the server's engine
(重写 NetworkServerBaseServerStart(Int32).)
受保护的方法SocketAcceptExtraCheck
当客户端的socket登录的时候额外检查的操作,并返回操作的结果信息。
The operation is additionally checked when the client's socket logs in, and the result information of the operation is returned.
(继承自 NetworkServerBase。)
受保护的方法StartInitialization
服务器启动时额外的初始化信息,可以用于启动一些额外的服务的操作。
The extra initialization information when the server starts can be used to start some additional service operations.
(重写 NetworkServerBaseStartInitialization.)
受保护的方法ThreadPoolLogin
当客户端连接到服务器,并听过额外的检查后,进行回调的方法
Callback method when the client connects to the server and has heard additional checks
(重写 NetworkServerBaseThreadPoolLogin(Socket, IPEndPoint).)
受保护的方法ThreadPoolSocketCheckTimeOut
检查网络套接字是否操作超时,传入的参数需要是HslTimeOut类型,封装socket操作。
Check if the operation of the network socket has timed out. The parameters passed in need to be of type HslTimeOut to encapsulate the socket operation.
(继承自 NetworkBase。)
公共方法ToString
Returns a string that represents the current object.
(重写 NetworkServerBaseToString.)
受保护的方法WriteStream
将缓冲区的数据写入到流里面去
Write the buffer data to the stream
(继承自 NetworkBase。)
受保护的方法WriteStreamAsync
将缓冲区的数据写入到流里面去
Write the buffer data to the stream
(继承自 NetworkBase。)
受保护的方法WriteStreamFromSocket
从套接字中接收所有的数据然后写入到指定的流当中去,需要指定数据的长度,支持按照百分比进行进度报告
Receives all data from the socket and writes it to the specified stream. The length of the data needs to be specified, and progress reporting is supported in percentage.
(继承自 NetworkBase。)
受保护的方法WriteStreamFromSocketAsync
从套接字中接收所有的数据然后写入到指定的流当中去,需要指定数据的长度,支持按照百分比进行进度报告
Receives all data from the socket and writes it to the specified stream. The length of the data needs to be specified, and progress reporting is supported in percentage.
(继承自 NetworkBase。)
Top
事件
  名称说明
公共事件OnClientApplicationMessageReceive
websocket的消息收到时触发
Triggered when a websocket message is received
公共事件OnClientConnected
websocket的客户端连接上来时触发
Triggered when a websocket client connects
Top
字段
  名称说明
受保护的字段CoreSocket
对客户端而言是的通讯用的套接字,对服务器来说是用于侦听的套接字
A communication socket for the client, or a listening socket for the server
(继承自 NetworkBase。)
受保护的字段fileCacheSize
文件传输的时候的缓存大小,直接影响传输的速度,值越大,传输速度越快,越占内存,默认为100K大小
The size of the cache during file transfer directly affects the speed of the transfer. The larger the value, the faster the transfer speed and the more memory it takes. The default size is 100K.
(继承自 NetworkBase。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
示例
使用本组件库可以非常简单方便的构造属于你自己的websocket服务器,从而实现和其他的客户端进行通信,尤其是和网页进行通讯,
简单的实例化
// 定义一个对象
// Define an object
public WebSocketServer webSocketServer;

public void Start( )
{
    try
    {
        webSocketServer = new WebSocketServer( );
        webSocketServer.ServerStart( 1883 );
    }
    catch(Exception ex)
    {
        Console.WriteLine( ex.Message );
    }
}
当客户端发送数据给服务器的时候,会发一个事件,并且把当前的会话暴露出来,下面举例打印消息,并且演示一个例子,发送数据给指定的会话。
接触数据
public WebSocketServer webSocketServer;

public void Start( )
{
    try
    {
        webSocketServer = new WebSocketServer( );
        webSocketServer.OnClientApplicationMessageReceive += WebSocketServer_OnClientApplicationMessageReceive;
        // 如果要控制心跳时间,需要在ServerStart方法调用之前
        webSocketServer.KeepAliveSendInterval = TimeSpan.FromSeconds( 20 ); // 默认间隔30秒发送客户端一次心跳
        webSocketServer.KeepAlivePeriod = TimeSpan.FromSeconds( 100 );      // 如果100秒之内都没有任何的心跳回复,就认为掉线了
        webSocketServer.ServerStart( 1883 );
    }
    catch (Exception ex)
    {
        Console.WriteLine( ex.Message );
    }
}

private void WebSocketServer_OnClientApplicationMessageReceive( WebSocketSession session, WebSocketMessage message )
{
    // 当接收到客户端的数据的时候触发,session参数就是会话信息,你可以选择打印数据,或是回发数据
    // Triggered when data is received from the client. The session parameter is the session information. You can choose to print the data or send it back.
    Console.WriteLine( message.ToString( ) );
    webSocketServer.SendClientPayload( session, "I hava received your data, thank you" );
}
也可以在其他地方发送数据给所有的客户端,只要调用一个方法就可以了。
发送数据
// 以下的信息会发布到所有的连接的客户端,包括网页端或是桌面程序
// The following information will be published to all connected clients, including web or desktop
private void Button1_Click(object sender, EventArgs e )
{
    webSocketServer.PublishAllClientPayload( "This is sample data, thank you for use hslcommunication" );
}
当客户端上线之后也触发了当前的事件,我们可以手动捕获到
捕获上线事件
public WebSocketServer webSocketServer;

public void Start( )
{
    try
    {
        webSocketServer = new WebSocketServer( );
        webSocketServer.OnClientApplicationMessageReceive += WebSocketServer_OnClientApplicationMessageReceive;
        webSocketServer.OnClientConnected += ( WebSocketSession session ) =>
        {
            Console.WriteLine( session.Remote.ToString( ) + " Online" );
        };
        webSocketServer.ServerStart( 1883 );
    }
    catch (Exception ex)
    {
        Console.WriteLine( ex.Message );
    }
}


private void WebSocketServer_OnClientApplicationMessageReceive( WebSocketSession session, WebSocketMessage message )
{
    // 当接收到客户端的数据的时候触发,session参数就是会话信息,你可以选择打印数据,或是回发数据
    // Triggered when data is received from the client. The session parameter is the session information. You can choose to print the data or send it back.
    Console.WriteLine( message.ToString( ) );
    webSocketServer.SendClientPayload( session, "I hava received your data, thank you" );
}
我们再来看看一个高级的操作,实现订阅,大多数的情况,websocket被设计成了订阅发布的操作。基本本服务器可以扩展出非常复杂功能的系统,我们来看一种最简单的操作。
客户端给服务器发的数据都视为主题(topic),这样服务器就可以辨认出主题信息,并追加主题。如下这么操作。
订阅实现
public WebSocketServer webSocketServer;

public void Start( )
{
    try
    {
        webSocketServer = new WebSocketServer( );
        webSocketServer.OnClientApplicationMessageReceive += WebSocketServer_OnClientApplicationMessageReceive;
        webSocketServer.ServerStart( 1883 );
    }
    catch (Exception ex)
    {
        Console.WriteLine( ex.Message );
    }
}

private void WebSocketServer_OnClientApplicationMessageReceive( WebSocketSession session, WebSocketMessage message )
{
    // 客户端发过来的数据就是订阅的主题,服务器在收到数据后加入到订阅的数据信息里去,假如订阅的数据已经存在,会自动推送数据
    // The data sent by the client is the subject of the subscription. After receiving the data, the server adds it to the subscribed data information. 
    // If the subscribed data already exists, it will automatically push the data.
    Console.WriteLine( message.ToString( ) );
    string topic = Encoding.UTF8.GetString( message.Payload );
    if(!string.IsNullOrEmpty( topic ))
    {
        webSocketServer.AddSessionTopic( session, topic );
    }
}
然后在发布的时候,调用下面的代码。
发布数据
// 以下的信息会发布到所有的连接的客户端,包括网页端或是桌面程序
// The following information will be published to all connected clients, including web or desktop
private void Button1_Click( object sender, EventArgs e )
{
    webSocketServer.PublishClientPayload( "A", "This is sample data, thank you for use hslcommunication" );
}
可以看到,我们这里只有订阅操作,如果想要实现更为复杂的操作怎么办?丰富客户端发来的数据,携带命令,数据,就可以区分了。比如json数据。具体的实现需要看各位能力了。
参见