buzz.getcoco.iot

Class CocoClient.ConnectivityTimers

java.lang.Object

buzz.getcoco.iot.CocoClient.ConnectivityTimers

Enclosing class:

CocoClient

public static final class CocoClient.ConnectivityTimers
extends java.lang.Object

This class defines default SDK timeouts and allows developer to set his/her own SDK timers.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_BACKGROUND_MAX_RETRY_PERIOD default time in seconds for backgroundMaxRetryPeriod.
static long	DEFAULT_FAST_RETRY_DURATION default time in seconds for fastRetryDuration.
static long	DEFAULT_FOREGROUND_MAX_RETRY_PERIOD default time in seconds for foregroundMaxRetryPeriod.
static long	DEFAULT_KEEP_ALIVE_INTERVAL default time in seconds for keepAliveInterval.
static long	DEFAULT_KEEP_ALIVE_TIMEOUT default time in seconds for keepAliveTimeout.

Constructor Summary

Constructors

Constructor and Description
ConnectivityTimers() Empty constructor that initializes default timers.
ConnectivityTimers(long fastRetryDuration, long backgroundMaxRetryPeriod, long foregroundMaxRetryPeriod, long keepAliveInterval, long keepAliveTimeout) Overloaded constructor for a developer to set customized timers.

Method Summary

Modifier and Type	Method and Description
CocoClient.ConnectivityTimers	toBackgroundMaxRetryPeriod(long backgroundMaxRetryPeriod) Get a new timer with just the background retry period changed.
CocoClient.ConnectivityTimers	toFastRetryDuration(long fastRetryDuration) Get a new timer with just the retry duration changed.
CocoClient.ConnectivityTimers	toForegroundMaxRetryPeriod(long foregroundMaxRetryPeriod) Get a new timer with just the foreground retry period changed.
CocoClient.ConnectivityTimers	toKeepAliveInterval(long keepAliveInterval) Get a new timer with just the keep alive interval changed.
CocoClient.ConnectivityTimers	toKeepAliveTimeout(long keepAliveTimeout) Get a new timer with just the keep alive timeout changed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FAST_RETRY_DURATION

public static final long DEFAULT_FAST_RETRY_DURATION

default time in seconds for fastRetryDuration.

See Also:

Constant Field Values

DEFAULT_BACKGROUND_MAX_RETRY_PERIOD

public static final long DEFAULT_BACKGROUND_MAX_RETRY_PERIOD

default time in seconds for backgroundMaxRetryPeriod.

See Also:

Constant Field Values

DEFAULT_FOREGROUND_MAX_RETRY_PERIOD

public static final long DEFAULT_FOREGROUND_MAX_RETRY_PERIOD

default time in seconds for foregroundMaxRetryPeriod.

See Also:

Constant Field Values

DEFAULT_KEEP_ALIVE_TIMEOUT

public static final long DEFAULT_KEEP_ALIVE_TIMEOUT

default time in seconds for keepAliveTimeout.

See Also:

Constant Field Values

DEFAULT_KEEP_ALIVE_INTERVAL

public static final long DEFAULT_KEEP_ALIVE_INTERVAL

default time in seconds for keepAliveInterval.

See Also:

Constant Field Values

Constructor Detail

ConnectivityTimers

public ConnectivityTimers()

Empty constructor that initializes default timers.

ConnectivityTimers

public ConnectivityTimers(long fastRetryDuration,
                          long backgroundMaxRetryPeriod,
                          long foregroundMaxRetryPeriod,
                          long keepAliveInterval,
                          long keepAliveTimeout)

Overloaded constructor for a developer to set customized timers.

Parameters:

fastRetryDuration - non-negative integer after which SDK will connect to other nodes

backgroundMaxRetryPeriod - interval when the app is in background connectivity mode

foregroundMaxRetryPeriod - interval when the app is in foreground connectivity mode

keepAliveInterval - SDK nodes will send a keep alive packet at keepAliveInterval seconds

keepAliveTimeout - the timeout in seconds for which SDK will wait

Method Detail

toFastRetryDuration

public CocoClient.ConnectivityTimers toFastRetryDuration(long fastRetryDuration)

Get a new timer with just the retry duration changed.

Parameters:

fastRetryDuration - The new fastRetryDuration to use

Returns:

The new Timer with modified value

toBackgroundMaxRetryPeriod

public CocoClient.ConnectivityTimers toBackgroundMaxRetryPeriod(long backgroundMaxRetryPeriod)

Get a new timer with just the background retry period changed.

Parameters:

backgroundMaxRetryPeriod - The new backgroundMaxRetryPeriod to use

Returns:

The new Timer with modified value

toForegroundMaxRetryPeriod

public CocoClient.ConnectivityTimers toForegroundMaxRetryPeriod(long foregroundMaxRetryPeriod)

Get a new timer with just the foreground retry period changed.

Parameters:

foregroundMaxRetryPeriod - The new foregroundMaxRetryPeriod to use

Returns:

The new Timer with modified value

toKeepAliveInterval

public CocoClient.ConnectivityTimers toKeepAliveInterval(long keepAliveInterval)

Get a new timer with just the keep alive interval changed.

Parameters:

keepAliveInterval - The new keepAliveInterval to use

Returns:

The new Timer with modified value

toKeepAliveTimeout

public CocoClient.ConnectivityTimers toKeepAliveTimeout(long keepAliveTimeout)

Get a new timer with just the keep alive timeout changed.

Parameters:

keepAliveTimeout - The new keepAliveTimeout to use

Returns:

The new Timer with modified value