API reference
API reference
Select your platform
No SDKs available
No versions available

WebSockets Namespace

Enumeration Types

Enumeration WebSocketCloseCode

Web socket close codes
NotSet
= 0
Normal
= 1000
Away
= 1001
ProtocolError
= 1002
UnsupportedData
= 1003
Undefined
= 1004
NoStatus
= 1005
Abnormal
= 1006
InvalidData
= 1007
PolicyViolation
= 1008
TooBig
= 1009
MandatoryExtension
= 1010
ServerError
= 1011
TlsHandshakeFailure
= 1015

Enumeration WitWebSocketConnectionState

Various connection state options for a web socket client
Disconnected
Not connected to a server
Connecting
Currently connecting or authenticating with a server
Connected
Connected and ready to send data
Disconnecting
Currently disconnecting from a server

Functions

A callback to process a response for a request originating from a different source with a topic this client has subscribed to. Should return true if processed successfully and false if not processed successfully.
Called one or more times to thread when a chunk has returned
Parameters
requestId
Request id used for chunk lookup and prioritization.
jsonData
Decoded json data object.
binaryData
Decoded binary data chunk which may be null or empty.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon