org.eclipse.paho.client.mqttv3

Class ScheduledExecutorPingSender

java.lang.Object

org.eclipse.paho.client.mqttv3.ScheduledExecutorPingSender

All Implemented Interfaces:

MqttPingSender

public class ScheduledExecutorPingSender
extends Object
implements MqttPingSender

Default ping sender implementation

This class implements the IMqttPingSender pinger interface allowing applications to send ping packet to server every keep alive interval.

See Also:

MqttPingSender

Constructor Summary

Constructors

Constructor and Description
ScheduledExecutorPingSender(ScheduledExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
void	init(ClientComms comms) Initial method.
void	schedule(long delayInMilliseconds) Schedule next ping in certain delay.
void	start() Start ping sender.
void	stop() Stop ping sender.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduledExecutorPingSender

public ScheduledExecutorPingSender(ScheduledExecutorService executorService)

Method Detail

init

public void init(ClientComms comms)

Description copied from interface: MqttPingSender

Initial method. Pass interal state of current client in.

Specified by:

init in interface MqttPingSender

start

public void start()

Description copied from interface: MqttPingSender

Start ping sender. It will be called after connection is success.

Specified by:

start in interface MqttPingSender

stop

public void stop()

Description copied from interface: MqttPingSender

Stop ping sender. It is called if there is any errors or connection shutdowns.

Specified by:

stop in interface MqttPingSender

schedule

public void schedule(long delayInMilliseconds)

Description copied from interface: MqttPingSender

Schedule next ping in certain delay.

Specified by:

schedule in interface MqttPingSender