Dispatch SDK Methods

Dispatch SDK calls. More...

Data Structures
struct	Dispatch_Settings
struct	Dispatch_Connection
struct	Dispatch_Stats
struct	Dispatch_SettingsResult
struct	Dispatch_StatsResult

Typedefs
typedef bool(*	Dispatch_SettingsCallback) (Dispatch_SettingsResult, void *)
typedef bool(*	Dispatch_StatsCallback) (Dispatch_StatsResult, void *)

Enumerations
enum	Dispatch_RoutingMode { DRM_SINGLE , DRM_FAILOVER , DRM_ROUND_ROBIN }
enum	Dispatch_Quality {   DQ_STABLE , DQ_INITIAL , DQ_FAILING , DQ_FAILED ,   DQ_UNKNOWN }

Functions
const char *	Dispatch_RoutingMode_toString (Dispatch_RoutingMode mode)
const char *	Dispatch_Quality_toString (Dispatch_Quality quality)
Dispatch_SettingsResult	Dispatch_GetSettings (CSpeedifySDK sdk, Dispatch_SettingsCallback callback, void *userData)
Dispatch_SettingsResult	Dispatch_SetRoutingMode (CSpeedifySDK sdk, Dispatch_RoutingMode mode, Dispatch_SettingsCallback callback, void *userData)
Dispatch_SettingsResult	Dispatch_SetMonitoringPingDestination (CSpeedifySDK sdk, SpeedifySDK_IPAddressString destination, Dispatch_SettingsCallback callback, void *userData)
Dispatch_StatsResult	Dispatch_GetStats (CSpeedifySDK sdk, Dispatch_StatsCallback callback, void *userData)

Detailed Description

Dispatch SDK calls.

The main interface to the Dispatch SDK for Desktop/Embedded
For all methods that take a callback, specifying a callback of NULL will perform synchronous calls. If your specify a callback, this method will not block and your callback will be called from another thread.
Methods marked 'Supports Subscription' support subscribing to updates for that result. Return true from the callback to continue receiving updates. Return false to stop. The result object returned from these methods includes an eventId that can be used to disable further updates;
Methods marked 'Subscription Only' must be given a callback.

Typedef Documentation

Dispatch_SettingsCallback

typedef bool(* Dispatch_SettingsCallback) (Dispatch_SettingsResult, void *)

A callback for a Dispatch_SettingsResult

Since

15.4

Dispatch_StatsCallback

typedef bool(* Dispatch_StatsCallback) (Dispatch_StatsResult, void *)

A callback for a Dispatch_StatsResult

Since

15.4

Enumeration Type Documentation

Dispatch_Quality

enum Dispatch_Quality

The detected quality of a connection

Since

15.4

Enumerator
DQ_STABLE	The connection is stable Since 15.4
DQ_INITIAL	Initial state while quality measurement is initialized Since 15.4
DQ_FAILING	The connection is failing Since 15.4
DQ_FAILED	The connection has failed Since 15.4
DQ_UNKNOWN	The quality is unknown Since 15.4

Dispatch_RoutingMode

enum Dispatch_RoutingMode

The routing mode for the Dispatch instance

Since

15.4

Enumerator
DRM_SINGLE	Single adapter mode. This is the legacy proxy mode behavior. Since 15.4
DRM_FAILOVER	Automatic fail over from a non-working connection to and working connection. Since 15.4
DRM_ROUND_ROBIN	Basic load balancing between multiple connections. Since 15.4

Function Documentation

Dispatch_GetSettings()

Dispatch_SettingsResult Dispatch_GetSettings	(	CSpeedifySDK	sdk,
		Dispatch_SettingsCallback	callback,
		void *	userData )

Get the current settings Supports Subscription

Parameters

sdk	SpeedifySDK object
callback	The callback to call with the result
userData	The user data to pass to the callback

Returns

settings result

Since

15.4

Dispatch_GetStats()

Dispatch_StatsResult Dispatch_GetStats	(	CSpeedifySDK	sdk,
		Dispatch_StatsCallback	callback,
		void *	userData )

Get the current statistics Supports Subscription

Parameters

sdk	SpeedifySDK object
callback	The callback to call with the result
userData	The user data to pass to the callback

Returns

stats result

Since

15.4

Dispatch_Quality_toString()

const char * Dispatch_Quality_toString

(

Dispatch_Quality

quality

)

Convert a Dispatch_Quality to a string

Parameters

quality

The quality to convert

Returns

The string representation of the mode

Since

15.4

Dispatch_RoutingMode_toString()

const char * Dispatch_RoutingMode_toString

(

Dispatch_RoutingMode

mode

)

Convert a Dispatch_RoutingMode to a string

Parameters

mode	The mode to convert

Returns

The string representation of the mode

Since

15.4

Dispatch_SetMonitoringPingDestination()

Dispatch_SettingsResult Dispatch_SetMonitoringPingDestination	(	CSpeedifySDK	sdk,
		SpeedifySDK_IPAddressString	destination,
		Dispatch_SettingsCallback	callback,
		void *	userData )

Configure the current monitoring ping destination

Parameters

sdk	SpeedifySDK object
destination	The new monitoring ping destination
callback	The callback to call with the result
userData	The user data to pass to the callback

Returns

settings result

Since

15.4

Dispatch_SetRoutingMode()

Dispatch_SettingsResult Dispatch_SetRoutingMode	(	CSpeedifySDK	sdk,
		Dispatch_RoutingMode	mode,
		Dispatch_SettingsCallback	callback,
		void *	userData )

Configure the current routing mode

Parameters

sdk	SpeedifySDK object
mode	The new routing mode
callback	The callback to call with the result
userData	The user data to pass to the callback

Returns

settings result

Since

15.4