网页包
这个库用来创建/验证AdonisJs使用的websocket包.
如果您正在编写 Javascript 客户端, 这是您必须使用的库 。 在为其他平台编写客户端库时,只需遵循文档和代码来创建您的执行.
安装
节点/网络包装
npm i --save @adonisjs/websocket-packet
const wsp = require('@adonisjs/websocket-packet')
// or
import wsp from '@adonisjs/websocket-packet'
console.log(wsp.codes)
wsp.isJoinPacket(packet)
光盘N
<script src="https://unpkg.com/@adonisjs/websocket-packet"></script>
<script type="text/javascript">
console.log(adonis.wsp.codes)
console.log(adonis.wsp.isJoinPacket(packet))
</script>
常数
职能
- 是JoinPacket( 软件包) ⇒
Boolean 如果包代码是
JOIN代码.- 是LeavePacket( 软件包) ⇒
Boolean 如果包代码是
LEAVE代码.- 是 OpenPacket( 软件包) ⇒
Boolean 如果包代码是
OPEN代码.- 是JoinAckPacket(套件) ⇒
Boolean 如果包代码是
JOIN_ACK代码.- 是 JoinErrorPacket( 软件包) ⇒
Boolean 如果包代码是
JOIN_ERROR代码.- 是Leave AckPacket( 软件包) ⇒
Boolean 如果包代码是
LEAVE_ACK代码.- 是Leave ErrorPacket( 软件包) ⇒
Boolean 如果包代码是
LEAVE_ERROR代码.- 是 EventPacket( 软件包) ⇒
Boolean 如果包代码是
EVENT代码.- 是平板电脑( 软件包) ⇒
Boolean 如果包代码是
PING代码.- 是 PongPacket( 软件包) ⇒
Boolean 如果包代码是
PONG代码.- has Topic( 软件包) ⇒
Boolean 查找包是否有话题 .
- 是 ValidJoinPacket () (中文(简体) ) ⇒
Boolean 确定数据包是一个有效的连接数据包 。 打电话
isJoinPacket在使用这种方法之前.- 是 ValidLeavePacket () 密码 ⇒
Boolean 确定包是一个有效的休假包。 打电话
isLeavePacket在使用这种方法之前.- 是 ValidEvenet 软件包( ) ⇒
Boolean 确定包是一个有效的事件包 。 打电话
isEventPacket在使用这种方法之前.- 加入Packet(专题) ⇒
Object 制作组合
- 叶包(专题) ⇒
Object 做一个休假包
- 加入 AckPacket(专题) ⇒
Object 加入确认包
- 加入 ErrorPacket( 专题, 消息) ⇒
Object 合并错误包
- aCKPacket(专题) ⇒
Object 制作休假包
- 离开 ErrorPacket( 专题, 信件) ⇒
Object 制作出离开错误包
- 事件包(专题、事件、数据) ⇒
Object 制作事件包
- pingPacket () () ⇒
Object 制作 ping 包
- 海绵袋( ) ⇒
Object 做海绵包
代码 : Object
包裹密码. 实际的包会有数字
仁爱: 全球常数
示例
{
OPEN: 0,
JOIN: 1,
LEAVE: 2,
JOIN_ACK: 3,
JOIN_ERROR: 4,
LEAVE_ACK: 5,
LEAVE_ERROR: 6,
EVENT: 7,
PING: 8,
PONG: 9
}
单位
要导出的数量
是JoinPacket(套件) QQ Boolean
如果包代码是 JOIN 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 LeavePacket( 套件) QQ Boolean
如果包代码是 LEAVE 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 OpenPacket( 软件包) {} Boolean
如果包代码是 OPEN 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是JoinAckPacket(套件) {} Boolean
如果包代码是 JOIN_ACK 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 JOIN ErrorPacket( 包) QQ Boolean
如果包代码是 JOIN_ERROR 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是Leave AckPacket(套件) QQ Boolean
如果包代码是 LEAVE_ACK 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 Leave ErrorPacket( 包) QQ Boolean
如果包代码是 LEAVE_ERROR 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 EventPacket( 软件包) {} Boolean
如果包代码是 EVENT 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
平板电脑( 软件包) QQ Boolean
如果包代码是 PING 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 PongPacket( 套件) QQ Boolean
如果包代码是 PONG 代码.
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
has Topic( 套件) QQ Boolean
查找包是否有话题 .
仁爱:全球职能
| 参数 | 类型 |
|---|---|
| 数据包 | Object |
是 ValidJoinPacket () Boolean
确定数据包是一个有效的连接数据包 。 打电话 isJoinPacket
在使用这种方法之前.
是 ValidLeavePacket () QQ Boolean
确定包是一个有效的休假包。 打电话 isLeavePacket
在使用这种方法之前.
是 ValidEventPacket () @% Boolean
确定包是一个有效的事件包 。 打电话 isEventPacket
在使用这种方法之前.
加入Packet(专题) QQ Object
制作组合
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
叶包(专题) Object
做一个休假包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
加入 AckPacket(专题) {} Object
加入确认包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
加入 ErrorPacket( 专题、 消息) {} Object
合并错误包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串Error如果信件没有定义或字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
| 消息 | String |
aCKPacket(专题) Object
制作休假包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
离开 ErrorPacket( 专题, 信件) QQ Object
制作出离开错误包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串Error如果信件没有定义或字符串
| 参数 | 类型 |
|---|---|
| 专题 | String |
| 消息 | String |
事件包( 专题、 事件、 数据) QQ Object
制作事件包
仁爱:全球职能
掷出数字 :
Error如果主题没有定义或不是字符串Error如果事件没有定义Error未定义数据
| 参数 | 类型 |
|---|---|
| 专题 | String |
| 事件 | String |
| 数据 | Mixed |
pingPacket () Object
制作 ping 包
海绵袋( ) QQ Object
做海绵包
仁爱:全球职能