# web.socket.server 库模块帮助文档 ## web.socket.server 成员列表 # 支持单线程异步的WebSocket服务端可直接在界面线程中使用，不会阻塞界面，不需要创建多线程支持 Ping/Pong 帧心跳，客户端Pong帧单向心跳, 可调用close函数断线，并可调用connect函数实现重析连接服务器 ### web.socket.server.getSecAccept() # 获取WebSocket客户端配对密钥，参数指定服务端HTTP头中sec-websocket-accept返回的值 ### web.socket.server.getSecKey() # 获取WebSocket客户端密钥 ### web.socket.server.sha1() # 使用sha1算法取哈希值，并使用Base64编码为普通文本 ## web.socket 成员列表 # ### web.socket.server() # [返回对象:websocketserverObject](#websocketserverObject) ## websocketserverObject 成员列表 # ### websocketserverObject._beforeStop # ```aardio websocketserverObject._beforeStop = function(){ /*服务端关闭以前触发此回调函数是标准库保留接口用户不应使用此回调*/ } ``` ### websocketserverObject._onClientClosed # ```aardio websocketserverObject._onClientClosed = function(hSocket){ /*客户端连接已经关闭时触发， hSocket 参数为客户端连接套接字句柄，此函数在连接断开后一定会被触发，此回调函数是标准库保留接口，用户不应使用此回调*/ } ``` ### websocketserverObject._translateMessage # 此回调函数的参数与onMessage相同, 如果定义了这个回调函数, 那么此函数将在调用onMessage之前被调用, 如果此回调返回true则不再触发onMessage, 这个函数提供了一个机会用于自动处理客户端消息 ,为其他需要扩展web.socket.server功能的库所预留，一旦定义将不能修改 ### websocketserverObject.beforeStop # ```aardio websocketserverObject.beforeStop = function(){ /*服务端关闭以前触发*/ } ``` ### websocketserverObject.client() # [返回对象:tcpaclientObject](https://www.aardio.com/zh-cn/doc/library-reference/wsock/tcp/asyncClient.html#tcpaclientObject) ### websocketserverObject.client(hSocket) # 使用 @hSocket 参数指定的客户端连接套接字句柄获取 wsock.tcp.client 对象 ### websocketserverObject.clientCount() # 当前WebSocket客户端数目包含正在连接或正在断开连接的客户端不含已关闭的客户端 ### websocketserverObject.close(hSocket,code,reason) # 关闭连接, @hSocket 参数指定客户端连接套接字句柄 ### websocketserverObject.getLocalIp() # 返回当前绑定的本地 IP,端口号 ### websocketserverObject.getLocalPort() # 返回当前绑定的本地端口号 ### websocketserverObject.getRemoteIp(hSocket) # 返回客户端IP地址,端口, @hSocket 参数指定客户端连接套接字句柄 ### websocketserverObject.getUrl() # 获了服务端网址,可选指定目录或文件路径注意参数第一个字符不需要指定斜杠如果参数@2为true，IP "0.0.0.0"替换为上网卡IP而不是localhost 如果服务器启动失败不返回任何值 ### websocketserverObject.heartbeatData # 心跳帧发送的数据,默认为空数据这个值修改以后，只能在下次调用connect函数才会生效 ### websocketserverObject.heartbeatInterval # 服务端主动发送心跳 Ping 空帧间隔,默认为 30 分钟设为 -1 时禁用客户端心跳,一般不建议禁用这个值修改以后，只能在下次调用start函数才会生效 ### websocketserverObject.heartbeatType # 心跳帧发送的的帧类型, 默认为9,也就是Ping帧这个值修改以后，只能在下次调用start函数才会生效 ### websocketserverObject.httpServer # 单线程异步 HTTP服务端,wsock.tcp.asyncHttpServer对象浏览器组件发起异步 HTTP 请求支持 wsock.tcp.asyncHttpServer。请不要用 inet.http 等阻塞请求同一线程创建的 asyncHttpServer, 这会导致 asyncHttpServer 没有机会响应请求而导致死锁，如果确有这样的需求，可创建线程发起请求，或改用基于多线程的 wsock.tcp.simpleHttpServe, [返回对象:AsyncHttpServerObject](#AsyncHttpServerObject) ### websocketserverObject.isClosed(hSocket) # 连接是否已关闭, @hSocket 参数指定客户端连接套接字句柄 ### websocketserverObject.isConnected(hSocket) # 是否已连接并准备就绪可以发送数据, @hSocket 参数指定客户端连接套接字句柄 ### websocketserverObject.publish() # 发送数据给所有的客户端, 支持字符串或 buffer、结构体字符串作为UTF8文本类型发送,其他以二进制类型发送，成功返回true ### websocketserverObject.send(hSocket,) # 发送数据,支持字符串或 buffer、结构体字符串作为UTF8文本类型发送,其他以二进制类型发送, @hSocket 参数指定客户端连接套接字句柄，成功返回true ### websocketserverObject.sendData(hSocket,data,opcode,fin,rsv1,rsv2,rsv3) # 发送WebSocket数据包参数@1支持支持字符串或 buffer、结构体除参数@1以外,所以参数可选一般应当调用send函数，而不是调用sendData函数如果一定要使用这个函数,请阅读此函数源码,以及 WebSocket 协议相关说明 ### websocketserverObject.start(IP,端口,请求队列大小) # 启动单线程异步 WebSocket 服务端,成功返回 true,失败返回 null, 如果不写IP，则默认设为"0.0.0.0"也即监听本机所有IP,访问此服务端也不限制IP 限制仅本机可以访问建议写127.0.0.1 端口为0或省略则自动查找1025以后的空闲端口注意0-1023为系统通用服务保留端口, 1024-49151为用户服务端口,其中大约%9已由IANA注册分配 49152-65535为私有或临时端口 ### websocketserverObject.stop() # WebSocket服务端 ## websocketserverObject 事件列表 # ### websocketserverObject.onClientClosed # ```aardio websocketserverObject.onClientClosed = function(hSocket){ /*客户端连接已经关闭时触发, hSocket 参数为客户端连接套接字句柄, 此函数在连接断开后一定会被触发*/ } ``` ### websocketserverObject.onClose # ```aardio websocketserverObject.onClose = function(hSocket,err){ /*连接被关闭, hSocket 参数为客户端连接套接字句柄, err.code 为错误代码 err.reason 为错误原因客户端关闭连接并不保证一定会触发此消息但onClientClosed事件在关闭后一定会被触发*/ } ``` ### websocketserverObject.onError # ```aardio websocketserverObject.onError = function(hSocket,err){ /*发生错误, hSocket 参数指定客户端连接套接字句柄, err为错误信息*/ } ``` ### websocketserverObject.onFragment # ```aardio websocketserverObject.onFragment = function(hSocket,msg){ /*收到分片数据, hSocket 参数指定客户端连接套接字句柄, 第一个数据包使用msg.type指明类型,参考WebSocket协议规范后续数据包msg.type为0,最后一个数据包msg.fin为1 如果不指定这个回调函数,则自动并接分片数据后触发onMessage事件*/ } ``` ### websocketserverObject.onMessage # ```aardio websocketserverObject.onMessage = function(hSocket,msg){ /*收到服务端数据, hSocket 参数指定客户端连接套接字句柄, msg.type 为 1 时 msg.data 为文本, 否则 msg.data 为字节串（buffer 类型）*/ } ``` ### websocketserverObject.onOpen # ```aardio websocketserverObject.onOpen = function(hSocket){ /*客户端已切换到WebSocket服务， hSocket 参数为客户端连接套接字句柄*/ } ``` ### websocketserverObject.onUpgradeToWebsocket # ```aardio websocketserverObject.onUpgradeToWebsocket = function(hSocket,request,response,protocol,origin){ /* 用户发送HTTP请求切换到WebSocket协议, 可以在这里修改HTTP响应头中Sec-WebSocket-Protocol的值如果要阻止用户切换到WebSocket,用 response.close() 关闭请求，或调用 response.errorStatus() 函数返回错误代码即可，否则退出此函数后会继续切换到WebSocket协议。参数说明: hSocket为客户端套接字句柄 request为HTTP请求对象 response为HTTP应答对象 protocol为Sec-WebSocket-Protocol请求头的值*/ } ```