ws

websocket 支持模块

使用方法：

var ws = require('ws');

Field Summary

Type Method and Description
const public const CONTINUECONTINUECONTINUE

指定 websocket 消息类型 0，代表一个继续帧
const public const TEXTTEXTTEXT

指定 websocket 消息类型 1，代表一个文本帧
const public const BINARYBINARYBINARY

指定 websocket 消息类型 2，代表一个二进制帧
const public const CLOSECLOSECLOSE

指定 websocket 消息类型 8，连接关闭
const public const PINGPINGPING

指定 websocket 消息类型 9，代表一个 ping 帧
const public const PONGPONGPONG

指定 websocket 消息类型 10，代表一个 pong 帧
const public const CONNECTINGCONNECTINGCONNECTING
const public const OPENOPENOPEN
const public const CLOSINGCLOSINGCLOSING
const public const CLOSEDCLOSEDCLOSED

Method Summary

Type Method and Description
WebSocketMessage new Message()

创建一个 websocket 消息对象，参见 WebSocketMessage
WebSocketHandler new Handler()

创建一个 websocket 包协议转换处理器，参见 WebSocketHandler
WebSocket new Socket()
Stream connect(String url,String origin)

创建一个 websocket 连接，并返回握手成功的 Stream 对象
Handler upgrade(Function accept)

创建一个 websocket 协议处理器，从 http 接收 upgrade 请求并握手，生成 WebSocket 对象

Field Detail

CONTINUE

const public const CONTINUECONTINUECONTINUE

指定 websocket 消息类型 0，代表一个继续帧

TEXT

const public const TEXTTEXTTEXT

指定 websocket 消息类型 1，代表一个文本帧

BINARY

const public const BINARYBINARYBINARY

指定 websocket 消息类型 2，代表一个二进制帧

CLOSE

const public const CLOSECLOSECLOSE

指定 websocket 消息类型 8，连接关闭

PING

const public const PINGPINGPING

指定 websocket 消息类型 9，代表一个 ping 帧

PONG

const public const PONGPONGPONG

指定 websocket 消息类型 10，代表一个 pong 帧

CONNECTING

const public const CONNECTINGCONNECTINGCONNECTING

OPEN

const public const OPENOPENOPEN

CLOSING

const public const CLOSINGCLOSINGCLOSING

CLOSED

const public const CLOSEDCLOSEDCLOSED

Method Detail

Message

WebSocketMessage new Message()

创建一个 websocket 消息对象，参见 WebSocketMessage

Handler

WebSocketHandler new Handler()

创建一个 websocket 包协议转换处理器，参见 WebSocketHandler

Socket

WebSocket new Socket()

connect

Stream connect(String url,String origin)

创建一个 websocket 连接，并返回握手成功的 Stream 对象

Parameters

  • url 指定连接的 url，支持 ws:// 和 wss:// 协议

  • origin 指定连接的授权域名

Returns

返回连接成功的 Stream 对象，可能为 Socket 或者 SslSocket

upgrade

Handler upgrade(Function accept)

创建一个 websocket 协议处理器，从 http 接收 upgrade 请求并握手，生成 WebSocket 对象

Parameters

  • accept 连接成功处理函数，参数为 WebSocket 对象

Returns

返回协议处理器，可与 HttpServer, Chain, Routing 等对接