#include "speedifysdk/speedifysdk.h"

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
SpeedifySDK_EXTERN const char *	Dispatch_RoutingMode_toString (Dispatch_RoutingMode mode)

SpeedifySDK_EXTERN const char *	Dispatch_Quality_toString (Dispatch_Quality quality)

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

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

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

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

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

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

◆ Dispatch_GetStats()

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

◆ Dispatch_Quality_toString()

SpeedifySDK_EXTERN 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()

SpeedifySDK_EXTERN const char * Dispatch_RoutingMode_toString ( Dispatch_RoutingMode mode )

Convert a Dispatch_RoutingMode to a string