52 lines
1.4 KiB
Java
52 lines
1.4 KiB
Java
/*******************************************************************************
|
|
* Copyright (c) 2014 IBM Corp.
|
|
*
|
|
* All rights reserved. This program and the accompanying materials
|
|
* are made available under the terms of the Eclipse Public License v2.0
|
|
* and Eclipse Distribution License v1.0 which accompany this distribution.
|
|
*
|
|
* The Eclipse Public License is available at
|
|
* https://www.eclipse.org/legal/epl-2.0
|
|
* and the Eclipse Distribution License is available at
|
|
* https://www.eclipse.org/org/documents/edl-v10.php
|
|
*/
|
|
|
|
package org.eclipse.paho.mqttv5.client;
|
|
|
|
import org.eclipse.paho.mqttv5.client.internal.ClientComms;
|
|
|
|
/**
|
|
* Represents an object used to send ping packet to MQTT broker every keep alive
|
|
* interval.
|
|
*/
|
|
public interface MqttPingSender {
|
|
|
|
/**
|
|
* Initial method. Pass interal state of current client in.
|
|
*
|
|
* @param comms
|
|
* The core of the client, which holds the state information for
|
|
* pending and in-flight messages.
|
|
*/
|
|
void init(ClientComms comms);
|
|
|
|
/**
|
|
* Start ping sender. It will be called after connection is success.
|
|
*/
|
|
void start();
|
|
|
|
/**
|
|
* Stop ping sender. It is called if there is any errors or connection
|
|
* shutdowns.
|
|
*/
|
|
void stop();
|
|
|
|
/**
|
|
* Schedule next ping in certain delay.
|
|
*
|
|
* @param delayInMilliseconds
|
|
* delay in milliseconds.
|
|
*/
|
|
void schedule(long delayInMilliseconds);
|
|
|
|
} |