Package org.openhab.core.io.transport.mqtt.reconnect

Class PeriodicReconnectStrategy

java.lang.Object

org.openhab.core.io.transport.mqtt.reconnect.AbstractReconnectStrategy

org.openhab.core.io.transport.mqtt.reconnect.PeriodicReconnectStrategy

@NonNullByDefault
public class PeriodicReconnectStrategy
extends AbstractReconnectStrategy

This is an implementation of the AbstractReconnectStrategy. This strategy tries to reconnect after 10 seconds and then every 60 seconds after a broker connection has been lost.

Author:

David Graeff - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.io.transport.mqtt.reconnect.AbstractReconnectStrategy

brokerConnection

Constructor Summary

Constructors

Constructor	Description
PeriodicReconnectStrategy()	Use a default 60s reconnect frequency and try the first reconnect after 10s.
PeriodicReconnectStrategy(int reconnectFrequency, int firstReconnectAfter)	Create a PeriodicReconnectStrategy with the given reconnect frequency and first reconnect time parameters.

Method Summary

Modifier and Type	Method	Description
void	connectionEstablished()	The MqttConnectionObserver will call this method if a broker connection has been successfully established.
int	getFirstReconnectAfter()
int	getReconnectFrequency()
boolean	isReconnecting()	Return true if your implementation is trying to establish a connection, false otherwise.
boolean	isStarted()	Returns if the reconnect strategy has been started.
void	lostConnection()	The MqttConnectionObserver will call this method if a broker connection has been lost or couldn't be established.
void	start()	Start the reconnect strategy handling.
void	stop()	Stop the reconnect strategy handling.

Methods inherited from class org.openhab.core.io.transport.mqtt.reconnect.AbstractReconnectStrategy

getBrokerConnection, setBrokerConnection

Methods inherited from class java.lang.Object

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

Constructor Details

PeriodicReconnectStrategy

public PeriodicReconnectStrategy()

Use a default 60s reconnect frequency and try the first reconnect after 10s.

PeriodicReconnectStrategy

public PeriodicReconnectStrategy(int reconnectFrequency,
 int firstReconnectAfter)

Create a PeriodicReconnectStrategy with the given reconnect frequency and first reconnect time parameters.

Parameters:

reconnectFrequency - This strategy tries to reconnect in this frequency in ms.

firstReconnectAfter - After a connection is lost, the very first reconnect attempt will be performed after this time in ms.

Method Details

start

public void start()

Description copied from class: AbstractReconnectStrategy

Start the reconnect strategy handling.

Specified by:

start in class AbstractReconnectStrategy

stop

public void stop()

Description copied from class: AbstractReconnectStrategy

Stop the reconnect strategy handling.

It must be possible to restart a reconnect strategy again after it has been stopped.

Specified by:

stop in class AbstractReconnectStrategy

isStarted

public boolean isStarted()

Returns if the reconnect strategy has been started.

Returns:

true if started

lostConnection

public void lostConnection()

Description copied from class: AbstractReconnectStrategy

The MqttConnectionObserver will call this method if a broker connection has been lost or couldn't be established. Your implementation should start trying to reestablish a connection.

Specified by:

lostConnection in class AbstractReconnectStrategy

connectionEstablished

public void connectionEstablished()

Description copied from class: AbstractReconnectStrategy

The MqttConnectionObserver will call this method if a broker connection has been successfully established. Your implementation should stop reconnection attempts and release resources.

Specified by:

connectionEstablished in class AbstractReconnectStrategy

isReconnecting

public boolean isReconnecting()

Description copied from class: AbstractReconnectStrategy

Return true if your implementation is trying to establish a connection, false otherwise.

Specified by:

isReconnecting in class AbstractReconnectStrategy

getReconnectFrequency

public int getReconnectFrequency()

getFirstReconnectAfter

public int getFirstReconnectAfter()