API reference
API reference
Select your platform
No SDKs available
No versions available
WitWebSocketClient Class
Extends IWitWebSocketClient, ILogSource
An class for performing multi-threaded web socket communication to a Wit endpoint WitWebSocketClient is a wrapper for web socket communication that facilitates the safe upload and download of data between the Voice SDK and Wit.ai. The class handles connection, transmission and response handling for all socket communication. Three background threads are spawned by each WitWebSocketClient in order to handle encoding/uploading, downloading/decoding and response handling respectively. WitWebSocketClients contain a list of IWitWebSocketRequests which are used to facilitate upload and download of data. When sending a WitChunk the IWitWebSocketRequest’s request id will also be sent within the json data. When receiving a WitChunk, request id will be checked within the json data and the appropriate IWitWebSocketRequest will handle the response. If no matching request is found, the WitChunk’s topic id will be used to find the appropriate IWitWebSocketSubscriber which then will generate a request to handle the response.
Properties
WitWebSocketSettings Settings[Get]
The settings required to connect, authenticate and drive server/client communication.
string ConnectionRequestId[Get]
The unique id associated with this connection request
WitWebSocketConnectionState ConnectionState[Get]
Whether the web socket is disconnected, connecting, connected, or disconnecting.
bool IsAuthenticated[Get]
Whether authentication had completed successfully or not
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
TaskCompletionSource< bool > ConnectionCompletion[Get]
A task that will complete once the connection process completes. Response will be true if connected successfully and false otherwise.
IVLogger Logger[Get]
Fields
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
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.
PubSubTopicSubscriptionDelegate OnTopicSubscriptionStateChange
Callback when subscription state changes for a specific topic id
Action< string, IWitWebSocketRequest > OnTopicRequestTracked
Callback when a tracked topic generates a request
Member Functions
WitWebSocketClient
( WitWebSocketSettings settings )
Constructor with settings data
WitWebSocketClient
( IWitRequestConfiguration configuration )
Constructor that takes in IWitRequestConfiguration and generates default settings use it
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
async Task< string > SendRequestAsync
( 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
PubSubSubscriptionState GetTopicSubscriptionState
( string topicId )
Obtains the current subscription state for a specific topic
void Subscribe
( string topicId )
Method to subscribe to a specific topic id
void Unsubscribe
( string topicId )
Method to unsubscribe to a specific topic 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