buzz.getcoco.iot

Class ConnectivityStateManager

java.lang.Object

buzz.getcoco.iot.ConnectivityStateManager

All Implemented Interfaces:

CallbacksInterface, DefaultCallbacksInterface

public final class ConnectivityStateManager
extends java.lang.Object
implements DefaultCallbacksInterface

ConnectivityStateManager maintains states of networks and notifies Listener in case it changes. It is reliant on FiniteStateMachine to handle events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectivityStateManager.CacheState Class responsible to cache the list of connected networks.
static interface	ConnectivityStateManager.ConnectivityStateChangeListener Listener which is triggered by callbacks.
static class	ConnectivityStateManager.State An enum denoting possible values of state for network object.

Method Summary

Modifier and Type	Method and Description
ConnectivityStateManager.CacheState	cacheStates() This function is responsible for caching of networks that are in connected state.
static boolean	connect(Network network) A function to connect to a given network.
void	connectStatusCallback(Network network) A function that needs to be implemented by subscribers to get info regrading connection status of the Network.
static boolean	disconnect(Network network) A function to disconnect from given network.
static ConnectivityStateManager	getInstance() This function calls overloaded getInstance to retrieve the instance of ConnectivityStateManager with a null listener.
static ConnectivityStateManager	getInstance(ConnectivityStateManager.ConnectivityStateChangeListener listener) This overloaded function fetches instance of this class with assigned listener param.
java.lang.Exception	getRecentException() A function to get last exception occurred while connectInternal(Network) or disconnect(Network).
static ConnectivityStateManager.State	getState(Network network) This method fetches State of Network param sent.
void	networkDataCallback(Network network) A function that needs to be implemented by subscriber to listen to updates of network.
void	nodeConnectionStatusCallback(Network network, long nodeId, NodeType nodeType, boolean isOnline) A function that needs to be implemented by the subscriber to listen updates regarding node connection status.
void	restoreToCachedState() This function is responsible to restore the connection with the cached networks by reconnecting if needed.
void	restoreToCachedState(ConnectivityStateManager.CacheState cacheState) This function is responsible to restore the connection with the cached networks by reconnecting if needed.
void	setConnectingTimeout(long connectingDelay) A setter to overwrite the connectingDelay.
void	setLocal2Timeout(long localDelay2) A setter to overwrite the delay set for InternalState#LOCAL_2.
void	setLocal3Timeout(long localDelay3) A setter to overwrite the delay set for InternalState#LOCAL_3.
void	setLocalTimeout(long localDelay) A setter to overwrite the delay set for InternalState#LOCAL_1.

Methods inherited from class java.lang.Object

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

Methods inherited from interface buzz.getcoco.iot.DefaultCallbacksInterface

advertiseResourceCallback, commandStatusCallback, contentInfoCallback, deviceInfoCallback, deviceManagementStatusCallback, errorCallback, infoRequestCallback, infoRequestStatusCallback, infoResponseCallback, infoResponseStatusCallback, leaveNetworkStatusCallback, messageCallback, networkListCallback, networkManagementCommandCallback, networkMetadataCallback, receiveDataCallback, resourceAttributeCallback, resourceCallback, resourceCapabilityCallback, resourceExcludedCallback, resourceIncludedCallback, ruleDeletedCallback, ruleInfoCallback, sceneDeletedCallback, sceneInfoCallback, tunnelStatusCallback, zoneDeletedCallback, zoneInfoCallback

Method Detail

getInstance

public static ConnectivityStateManager getInstance()

This function calls overloaded getInstance to retrieve the instance of ConnectivityStateManager with a null listener.

Returns:

Instance of ConnectivityStateManager.

See Also:

getInstance(ConnectivityStateChangeListener)

getInstance

public static ConnectivityStateManager getInstance(ConnectivityStateManager.ConnectivityStateChangeListener listener)

This overloaded function fetches instance of this class with assigned listener param. NOTE: a weak-reference will be used to store the listener. So, the reference must be maintained by the caller.

Parameters:

listener - listens for network state change ConnectivityStateManager.ConnectivityStateChangeListener

Returns:

Instance of ConnectivityStateManager.

cacheStates

public ConnectivityStateManager.CacheState cacheStates()

This function is responsible for caching of networks that are in connected state.

Returns:

CacheState object with list of connected networks.

setConnectingTimeout

public void setConnectingTimeout(long connectingDelay)

A setter to overwrite the connectingDelay.

Parameters:

connectingDelay - timeout in millis.

setLocalTimeout

public void setLocalTimeout(long localDelay)

A setter to overwrite the delay set for InternalState#LOCAL_1.

Parameters:

localDelay - timeout in millis,

setLocal2Timeout

public void setLocal2Timeout(long localDelay2)

A setter to overwrite the delay set for InternalState#LOCAL_2.

Parameters:

localDelay2 - timeout in millis,

setLocal3Timeout

public void setLocal3Timeout(long localDelay3)

A setter to overwrite the delay set for InternalState#LOCAL_3.

Parameters:

localDelay3 - timeout in millis,

getRecentException

public java.lang.Exception getRecentException()

A function to get last exception occurred while connectInternal(Network) or disconnect(Network).

Returns:

Exception.

restoreToCachedState

public void restoreToCachedState()

This function is responsible to restore the connection with the cached networks by reconnecting if needed.

restoreToCachedState

public void restoreToCachedState(ConnectivityStateManager.CacheState cacheState)

This function is responsible to restore the connection with the cached networks by reconnecting if needed.

Parameters:

cacheState - used for caching networks in cacheStates()

disconnect

public static boolean disconnect(Network network)

A function to disconnect from given network.

Parameters:

network - Network from which needs to be disconnected.

Returns:

Flag represents if operation is successful.

connect

public static boolean connect(Network network)

A function to connect to a given network.

Parameters:

network - Network to which user needs to be connected.

Returns:

Flag if operation is successful.

connectStatusCallback

public void connectStatusCallback(Network network)

Description copied from interface: CallbacksInterface

A function that needs to be implemented by subscribers to get info regrading connection status of the Network.

Specified by:

connectStatusCallback in interface CallbacksInterface

Specified by:

connectStatusCallback in interface DefaultCallbacksInterface

Parameters:

network - Network whose connect status is updated.

nodeConnectionStatusCallback

public void nodeConnectionStatusCallback(Network network,
                                         long nodeId,
                                         NodeType nodeType,
                                         boolean isOnline)

Description copied from interface: CallbacksInterface

A function that needs to be implemented by the subscriber to listen updates regarding node connection status.

Specified by:

nodeConnectionStatusCallback in interface CallbacksInterface

Specified by:

nodeConnectionStatusCallback in interface DefaultCallbacksInterface

Parameters:

network - Network Whose node status is changed.

nodeId - ID of the node.

nodeType - Type of the node.

isOnline - Flag representing if node is online.

networkDataCallback

public void networkDataCallback(Network network)

Description copied from interface: CallbacksInterface

A function that needs to be implemented by subscriber to listen to updates of network.

Specified by:

networkDataCallback in interface CallbacksInterface

Specified by:

networkDataCallback in interface DefaultCallbacksInterface

Parameters:

network - Network whose data is updated.

getState

public static ConnectivityStateManager.State getState(Network network)

This method fetches State of Network param sent.

Parameters:

network - Network object in interest.

Returns:

state from the ConnectivityStateManager.State enum.