Class WebSocket

表示一个 WebSocket 连接

Hierarchy

EventEmitter
- WebSocket

Index

Constructors

constructor

Properties

Accessors

bufferedAmount

Constructors

constructor

new WebSocket(url: string | UrlObject | URL, protocols?: string | readonly, string: any, __namedParameters: [], options?: WebSocketOptions): WebSocket
new WebSocket(socket: Socket, protocol?: string, options?: Pick<WebSocketOptions, "maxBufferSize" | "extension">): WebSocket

- Defined in webSocket.ts:24
初始化新的 WebSocket 客户端

Parameters
- url: string | UrlObject | URL
  
  要连接的服务端地址
- Optional protocols: string | readonly
  
  所有可用的子协议
- string: any
- __namedParameters: []
- Optional options: WebSocketOptions
  
  附加选项
Returns WebSocket
- Defined in webSocket.ts:32
初始化新的 WebSocket 服务端

Parameters
- socket: Socket
  
  已连接的 TCP/IP 协议套接字
- Optional protocol: string
  
  当前使用的子协议
- Optional options: Pick<WebSocketOptions, "maxBufferSize" | "extension">
  
  附加选项
Returns WebSocket

Properties

Optional extension

extension: WebSocketExtension

获取当前使用的 WebSocket 扩展

mask

mask: boolean

判断发送数据前是否添加掩码以避免缓存服务器攻击

maxBufferSize

maxBufferSize: number = 100 * 1024 * 1024

获取允许的每个数据块的最大字节长度

Optional protocol

protocol: string

获取当前使用的子协议

readyState

readyState: WebSocketState = WebSocketState.connecting

获取当前 WebSocket 的状态

socket

socket: Socket

获取关联的 TCP/IP 协议套接字

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

bufferedAmount

get bufferedAmount(): number

- Defined in webSocket.ts:277
获取已缓存但未发送的字节数

Returns number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(code?: number, reason?: string, timeout?: number): void

- Defined in webSocket.ts:630
发送一个关闭连接帧并关闭连接

Parameters
- Optional code: number
  
  关闭的状态码
- Optional reason: string
  
  关闭的原因
- Default value timeout: number = 30000
  
  等待服务器响应的超时毫秒数，如果为 0 则不设置超时
Returns void

destroy

destroy(error?: Error): void

- Defined in webSocket.ts:667
强制关闭连接

Parameters
- Optional error: Error
  
  关联的错误对象
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:20
Returns number

Protected handleSocketClose

handleSocketClose(): void

- Defined in webSocket.ts:706
处理连接关闭事件

Returns void

Protected handleSocketData

handleSocketData(data: Buffer): void

- Defined in webSocket.ts:326
处理 TCP/IP 套接字接收数据事件

Parameters
- data: Buffer
  
  接收的数据
Returns void

Protected handleSocketError

handleSocketError(error: Error): void

- Defined in webSocket.ts:713
处理连接错误事件

Parameters
- error: Error
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Protected onClose

onClose(data: Buffer, code?: number, reason?: string): void

- Defined in webSocket.ts:596
当接收到关闭请求后执行

Parameters
- data: Buffer
  
  请求的附加数据
- Optional code: number
  
  远程发送的状态码
- Optional reason: string
  
  远程关闭的原因
Returns void

Protected onConnectError

onConnectError(error: Error): void

- Defined in webSocket.ts:171
当连接错误后执行

Parameters
- error: Error
  
  处理打开错误
Returns void

Protected onMessage

onMessage(data: string | Buffer): void

- Defined in webSocket.ts:569
当接收到数据后执行

Parameters
- data: string | Buffer
  
  接收的数据
Returns void

Protected onParseError

onParseError(code: number, message: string): void

- Defined in webSocket.ts:524
当数据解析错误后执行

Parameters
- code: number
  
  错误的状态码
- message: string
  
  错误的信息
Returns void

Protected onPing

onPing(data: Buffer): void

- Defined in webSocket.ts:577
当接收到“乒”请求后执行

Parameters
- data: Buffer
  
  请求的附加数据
Returns void

Protected onPong

onPong(data: Buffer): void

- Defined in webSocket.ts:586
当接收到“乓”响应后执行

Parameters
- data: Buffer
  
  请求的附加数据
Returns void

Protected onReceive

onReceive(buffers: Buffer[], length: number, opcode: WebSocketOpcode, rsv: WebSocketExtensionRSV): void

- Defined in webSocket.ts:535
当数据解析完成后执行

Parameters
- buffers: Buffer[]
  
  接收到的所有数据
- length: number
  
  接收到的所有数据字节长度
- opcode: WebSocketOpcode
  
  操作码
- rsv: WebSocketExtensionRSV
  
  扩展码
Returns void

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

ref

ref(): this

- Defined in webSocket.ts:178
使当前进程等待当前连接停止后退出

Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(data: string | Buffer | ArrayBuffer | SharedArrayBuffer | Uint8Array, callback?: function): void

- Defined in webSocket.ts:209
向远程发送一段数据

Parameters
- data: string | Buffer | ArrayBuffer | SharedArrayBuffer | Uint8Array
  
  要发送的数据
- Optional callback: function
  
  发送成功后的回调函数
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

sendPayload

sendPayload(data: string | Buffer | ArrayBuffer | SharedArrayBuffer | Uint8Array, opcode: WebSocketOpcode, final?: boolean, rsv?: WebSocketExtensionRSV, mask?: boolean, dataImmutable?: boolean, callback?: function): void

- Defined in webSocket.ts:223
底层发送一个 WebSocket 帧

Parameters
- data: string | Buffer | ArrayBuffer | SharedArrayBuffer | Uint8Array
  
  要发送的数据
- opcode: WebSocketOpcode
  
  操作码
- Optional final: boolean
  
  当前帧是否是最后一帧
- Optional rsv: WebSocketExtensionRSV
  
  扩展码
- Optional mask: boolean
  
  是否添加掩码以避免缓存服务器攻击
- Optional dataImmutable: boolean
  
  是否禁止函数修改 data
- Optional callback: function
  
  发送完成后的回调函数
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

unref

unref(): this

- Defined in webSocket.ts:188
允许当前进程不等待当前连接停止直接退出

Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in D:/项目/TPack/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc