org.eclipse.paho.client.mqttv3

Interface MqttPingSender

All Known Implementing Classes:

TimerPingSender

public interface MqttPingSender

Represents an object used to send ping packet to MQTT broker every keep alive interval.

Method Summary

Methods

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

Method Detail

init

void init(org.eclipse.paho.client.mqttv3.internal.ClientComms comms)

Initial method. Pass interal state of current client in.

Parameters:

The - core of the client, which holds the state information for pending and in-flight messages.

start

void start()

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

stop

void stop()

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

schedule

void schedule(long delayInMilliseconds)

Schedule next ping in certain delay.

Parameters:

delay - in milliseconds.