Interface WebSocket

A WebSocket connection that is valid from open to close event

Hierarchy

WebSocket

Indexable

[key: string]: any

Arbitrary user data may be attached to this object

Index

Methods

Methods

close

close(): WebSocket

- Defined in index.d.ts:23
Forcefully closes this WebSocket

Returns WebSocket

cork

cork(cb: function): void

- Defined in index.d.ts:41
See HttpResponse.cork

Parameters
- cb: function
  - - (): void
    - Returns void
Returns void

end

end(code?: number, shortMessage?: RecognizedString): WebSocket

- Defined in index.d.ts:20
Gracefully closes this WebSocket. Immediately calls close handler.

Parameters
- Optional code: number
- Optional shortMessage: RecognizedString
Returns WebSocket

getBufferedAmount

getBufferedAmount(): number

- Defined in index.d.ts:17
Returns the bytes buffered in backpressure.

Returns number

getRemoteAddress

getRemoteAddress(): ArrayBuffer

- Defined in index.d.ts:44
Returns the remote IP address

Returns ArrayBuffer

ping

ping(message?: RecognizedString): boolean

- Defined in index.d.ts:26
Sends a ping control message. Returns true on success, see WebSocket.send. This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...).

Parameters
- Optional message: RecognizedString
Returns boolean

publish

publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): WebSocket

- Defined in index.d.ts:38
Publish a message to a topic in MQTT syntax

Parameters
- topic: RecognizedString
- message: RecognizedString
- Optional isBinary: boolean
- Optional compress: boolean
Returns WebSocket

send

send(message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean

- Defined in index.d.ts:14
Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given.

Parameters
- message: RecognizedString
- Optional isBinary: boolean
- Optional compress: boolean
Returns boolean

subscribe

subscribe(topic: RecognizedString): WebSocket

- Defined in index.d.ts:29
Subscribe to a topic in MQTT syntax

Parameters
- topic: RecognizedString
Returns WebSocket

unsubscribe

unsubscribe(topic: RecognizedString): boolean

- Defined in index.d.ts:32
Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed.

Parameters
- topic: RecognizedString
Returns boolean

unsubscribeAll

unsubscribeAll(): void

- Defined in index.d.ts:35
Unsubscribe from all topics.

Returns void

Generated using TypeDoc