com.hivemq.client.internal.mqtt.handler.ping

Class MqttPingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

com.hivemq.client.internal.mqtt.handler.MqttConnectionAwareHandler

com.hivemq.client.internal.mqtt.handler.ping.MqttPingHandler

All Implemented Interfaces:

DefaultChannelOutboundHandler, io.netty.channel.ChannelFutureListener, io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler, io.netty.util.concurrent.GenericFutureListener<io.netty.channel.ChannelFuture>, java.lang.Runnable, java.util.EventListener

@ConnectionScope
public class MqttPingHandler
extends MqttConnectionAwareHandler
implements DefaultChannelOutboundHandler, java.lang.Runnable, io.netty.channel.ChannelFutureListener

MQTT Keep Alive Handling.

• Sends a PINGREQ message when no write has been performed for the Keep Alive interval.
• Disconnects or closes the channel if the PINGRESP message is not received in the timeout.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull java.lang.String	NAME

Fields inherited from class com.hivemq.client.internal.mqtt.handler.MqttConnectionAwareHandler

ctx

Fields inherited from interface io.netty.channel.ChannelFutureListener

CLOSE, CLOSE_ON_FAILURE, FIRE_EXCEPTION_ON_FAILURE

Constructor Summary

Constructors

Constructor and Description
MqttPingHandler(int keepAlive)

Method Summary

Modifier and Type	Method and Description
void	channelRead(@NotNull io.netty.channel.ChannelHandlerContext ctx, @NotNull java.lang.Object msg)
void	flush(@NotNull io.netty.channel.ChannelHandlerContext ctx)
void	handlerAdded(@NotNull io.netty.channel.ChannelHandlerContext ctx)
protected void	onDisconnectEvent(@NotNull MqttDisconnectEvent disconnectEvent)
void	operationComplete(@NotNull io.netty.channel.ChannelFuture future)
void	run()

Methods inherited from class com.hivemq.client.internal.mqtt.handler.MqttConnectionAwareHandler

userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hivemq.client.internal.util.netty.DefaultChannelOutboundHandler

bind, close, connect, deregister, disconnect, read, write

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerRemoved

Field Detail

NAME

@NotNull
public static final @NotNull java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

MqttPingHandler

public MqttPingHandler(int keepAlive)

Method Detail

handlerAdded

public void handlerAdded(@NotNull
                         @NotNull io.netty.channel.ChannelHandlerContext ctx)

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class MqttConnectionAwareHandler

flush

public void flush(@NotNull
                  @NotNull io.netty.channel.ChannelHandlerContext ctx)

Specified by:

flush in interface DefaultChannelOutboundHandler

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

channelRead

public void channelRead(@NotNull
                        @NotNull io.netty.channel.ChannelHandlerContext ctx,
                        @NotNull
                        @NotNull java.lang.Object msg)

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

run

public void run()

Specified by:

run in interface java.lang.Runnable

operationComplete

public void operationComplete(@NotNull
                              @NotNull io.netty.channel.ChannelFuture future)

Specified by:

operationComplete in interface io.netty.util.concurrent.GenericFutureListener<io.netty.channel.ChannelFuture>

onDisconnectEvent

protected void onDisconnectEvent(@NotNull
                                 @NotNull MqttDisconnectEvent disconnectEvent)

Overrides:

onDisconnectEvent in class MqttConnectionAwareHandler