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.

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
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

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.

Action< WitWebSocketConnectionState >	OnConnectionStateChanged ( ) Callback on connection state change.
PubSubTopicSubscriptionDelegate	OnTopicSubscriptionStateChange ( ) Callback when subscription state changes for a specific topic id
Action< string, IWitWebSocketRequest >	OnTopicRequestTracked ( ) Callback when a tracked topic generates a request

	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
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.

WitWebSocketClient Class

Overview

Properties

Data Fields

Events

Public Member Functions

Details

Properties

Fields

Events

Member Functions