org.sensorhub.impl.module

Class RobustConnection

java.lang.Object

org.sensorhub.impl.module.RobustConnection

Direct Known Subclasses:

RobustIPConnection

public abstract class RobustConnection
extends Object

Helper class for handling automatic reconnections to remote devices/services.
It must be subclassed to provide an implementation of the tryConnect() method

Since:

Jun 25, 2016

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected RobustConnectionConfig	connectConfig
protected boolean	connected
protected AbstractModule<?>	module
protected String	remoteServiceName
protected Thread	waitThread

Constructor Summary

Constructors

Constructor and Description
RobustConnection(AbstractModule<?> module, RobustConnectionConfig config, String remoteServiceName)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the automatic reconnection loop if still running
boolean	isConnected()
void	reconnect() Helper method to reconnect after a disconnection has been detected The default implementation just restarts the module asynchronously.
abstract boolean	tryConnect() Implements the connection process. This is called for each connection attempt
void	updateConfig(RobustConnectionConfig config)
void	waitForConnection() Waits until the client is connected If connection is detected by another thread, this method can also be notified by calling stateLock.notify()

Methods inherited from class java.lang.Object

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

Field Detail

module

protected AbstractModule<?> module

connectConfig

protected RobustConnectionConfig connectConfig

remoteServiceName

protected String remoteServiceName

waitThread

protected Thread waitThread

connected

protected volatile boolean connected

Constructor Detail

RobustConnection

public RobustConnection(AbstractModule<?> module,
                RobustConnectionConfig config,
                String remoteServiceName)

Method Detail

updateConfig

public void updateConfig(RobustConnectionConfig config)

tryConnect

public abstract boolean tryConnect()
                            throws Exception

Implements the connection process.
This is called for each connection attempt

Returns:

true if successfully connected, false otherwise

Throws:

Exception - sent on error that requires aborting the connection process (no more connection attempts will be made after such exception is thrown)

waitForConnection

public void waitForConnection()
                       throws SensorHubException

Waits until the client is connected
If connection is detected by another thread, this method can also be notified by calling stateLock.notify()

Throws:

SensorHubException - on error preventing further attempts or max number of attempts reached

cancel

public void cancel()

Cancels the automatic reconnection loop if still running

reconnect

public void reconnect()

Helper method to reconnect after a disconnection has been detected
The default implementation just restarts the module asynchronously.

isConnected

public boolean isConnected()