1.3 UDPack Interface

constructor

• constructor(opts: object)

  opts 为配置选项

method

• connect(port: Number, address: string, callback: function): this

  UDPack 客户端连接 UDPack 服务端，创建 Session，通过 callback 可获发生的错误

• openStream(callback: function): this

  UDPack 客户端打开 Stream，通过 callback 可获得发生的错误或者新创建的 Stream 对象

• send(sessionOrStream: Session | Stream, buffer: Buffer, callback: function): this

  UDPack 通过 Session 或者 Stream 发送数据，通过 callback 可得知是否发送成功或者发生的错误

• close(): this

  关闭 UDPack

event

• listening

  UDPack 启动后触发 listening 事件

• shakehand

  服务端 UDPack 收到 shakehand 帧时触发 shakehand 事件，同时可获得 shakehand 返回码

• handshake

  客户端 UDPack 收到 handshake 帧时触发 handshake 事件，同时可获得 handshake 返回码

• session

  通信双方 UDPack 握手成功会话创建完成后触发 session 事件

• ping

  服务端 UDPack 收到心跳检测帧触发 ping 事件

• pong

  客户端 UDPack 收到心跳应答帧触发 pong 事件

• stream

  UDPack 创建 Stream 成功后触发 stream 事件，同时可获得新创建的 Stream 对象

• connect_error

  客户端 UDPack 连接服务端 UDPack 创建 Session 失败触发 connect_error 事件

• speed

  UDPack 每秒触发一次，可获得实时数据发送与接收速度

• error

  UDPack 内部发生错误时触发