commonMain.com.ditchoom.mqtt3.controlpacket.PingRequest.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mqtt-4-models Show documentation

Defines the MQTT 3 and 4 control packets

There is a newer version: 1.2.0

package com.ditchoom.mqtt3.controlpacket

import com.ditchoom.mqtt.controlpacket.IPingRequest
import com.ditchoom.mqtt.controlpacket.format.fixed.DirectionOfFlow

/**
 * 3.12 PINGREQ – PING request
 * The PINGREQ packet is sent from a Client to the Server. It can be used to:
 *
 * ·         Indicate to the Server that the Client is alive in the absence of any other MQTT Control Packets being
 * sent from the Client to the Server.
 *
 * ·         Request that the Server responds to confirm that it is alive.
 *
 * ·         Exercise the network to indicate that the Network Connection is active.
 *
 * This packet is used in Keep Alive processing. Refer to section 3.1.2.10 for more details.
 */
object PingRequest : ControlPacketV4(12, DirectionOfFlow.CLIENT_TO_SERVER), IPingRequest