API reference
API reference
Select your platform
No SDKs available
No versions available
IWitWebSocketClient Interface
Extends IPubSubSubscriber
An interface for all web socket client settings, state determinations, event callbacks, connection, disconnection and request interactions.
Properties
WitWebSocketSettings Settings[Get]
The settings required to connect, authenticate and drive server/client communication.
WitWebSocketConnectionState ConnectionState[Get]
Whether the web socket is disconnected, connecting, connected, or disconnecting.
bool IsAuthenticated[Get]
Whether authentication had completed successfully or not
bool IsUploading[Get]
Whether there currently is data being encoded and/or queued to be sent from the web socket.
bool IsDownloading[Get]
Whether there currently is data being received and/or decoded from the web socket.
bool IsReferenced[Get]
Whether there currently are any scripts that have called Connect() and not yet requested a Disconnect().
bool IsReconnecting[Get]
Whether will be reconnecting
int ReferenceCount[Get]
Total amount of scripts that have called Connect() and have not yet called Disconnect(). Used to ensure WebSocketClient is only disconnected once no scripts are still referenced.
int FailedConnectionAttempts[Get]
Total amount of failed connection attempts made
DateTime LastResponseTime[Get]
The utc time of the last response from the server
Dictionary< string, IWitWebSocketRequest > Requests[Get]
The requests currently being tracked by this client. Each access generates a new dictionary and should be cached.
Events
Action< WitWebSocketConnectionState > OnConnectionStateChanged
Callback on connection state change.
WitWebSocketResponseProcessor OnProcessForwardedResponse
An event callback for processing a response for a request originating on a different client with a topic this client has subscribed to.
Action< string, IWitWebSocketRequest > OnTopicRequestTracked
Callback when a tracked topic generates a request
Member Functions
void Connect ( )
Attempts to connect to the specified
void Disconnect ( )
Disconnects socket after checking state
bool SendRequest
( IWitWebSocketRequest request )
Send a request via this client if possible
bool TrackRequest
( IWitWebSocketRequest request )
Safely adds a request to the current request list
bool UntrackRequest
( IWitWebSocketRequest request )
Safely removes a request from the current request list
bool UntrackRequest
( string requestId )
Safely removes a request from the current request list by request id
void Unsubscribe
( string topicId,
bool ignoreRefCount )
Method to subscribe to a specific topic id with a parameter to ignore ref count for local unsubscribing following disconnect/error.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta