Dispatch Class Reference

Dispatch is an extension to the SpeedifySDK to enable automatic fail over and load balancing in proxy mode. More...

Classes
class	Connection
	Information about a connection. More...
enum	Quality
	The detected quality of a connection. More...
enum	RoutingMode
	The routing mode for the Dispatch instance. More...
class	Settings
	The settings for the Dispatch instance. More...
class	Stats
	The statistics for the Dispatch instance. More...

Public Member Functions
	Dispatch (@NonNull SpeedifySDK sdk)
	Creates a new Dispatch instance.
final void	setRoutingMode (RoutingMode mode)
	Configure the current routing mode.
final void	refreshSettings ()
	Get the current settings.
final void	refreshStats ()
	Get the current statistics.
final void	setMonitoringPingDestination (String destination)
	Set the destination IP for monitoring pings.

Static Public Member Functions
static Dispatch	getInstance ()
	Gets the current Dispatch instance.
static Dispatch	getInstance (Context context)
	Gets the current Dispatch instance.If there is no current instance and a context is passed, a new instance will be created.
static final String	Version ()
	Dispatch version.

Public Attributes
final MultiReceiverManager< IDispatchStateReceiver >	sdkStateReceivers = new MultiReceiverManager<IDispatchStateReceiver>()
	Registers a new SDK state receiver Receivers are WeakReferenced, so you must keep a reference to the receiver.

Detailed Description

Dispatch is an extension to the SpeedifySDK to enable automatic fail over and load balancing in proxy mode.

Since

15.4

Constructor & Destructor Documentation

Dispatch()

Dispatch

(

@NonNull SpeedifySDK

sdk

)

Creates a new Dispatch instance.

Parameters

sdk	the SpeedifySDK instance to use

Since

15.4

Member Function Documentation

getInstance() [1/2]

static Dispatch getInstance ( )

static

Gets the current Dispatch instance.

Returns

the Dispatch instance, or null

Since

15.4

getInstance() [2/2]

static Dispatch getInstance ( Context context )

static

Gets the current Dispatch instance.If there is no current instance and a context is passed, a new instance will be created.

This relies on SpeedifySDK.AutoConstruct

Returns

the Dispatch instance, or null

Since

15.4

refreshSettings()

final void refreshSettings

(

)

Get the current settings.

Since

15.4

refreshStats()

final void refreshStats

(

)

Get the current statistics.

Since

15.4

setMonitoringPingDestination()

final void setMonitoringPingDestination

(

String

destination

)

Set the destination IP for monitoring pings.

Parameters

destination

the destination IP to use

Since

15.4

setRoutingMode()

final void setRoutingMode

(

RoutingMode

mode

)

Configure the current routing mode.

Parameters

mode	the routing mode to use

Since

15.4

Version()

static final String Version ( )

static

Dispatch version.

Returns

string of the version, ie: 15.1.0+1

Since

15.4

Member Data Documentation

sdkStateReceivers

final MultiReceiverManager<IDispatchStateReceiver> sdkStateReceivers = new MultiReceiverManager<IDispatchStateReceiver>()

Registers a new SDK state receiver Receivers are WeakReferenced, so you must keep a reference to the receiver.

Parameters

receiver

the receiver to register

Since

15.4

---

The documentation for this class was generated from the following file:

• dispatch/src/main/java/com/speedify/speedifysdk/dispatch/Dispatch.java