org.kitteh.irc.client.library.defaults.feature.network

Class NettyConnection

java.lang.Object

org.kitteh.irc.client.library.defaults.feature.network.NettyConnection

All Implemented Interfaces:

ClientConnection

public final class NettyConnection
extends Object
implements ClientConnection

Constructor Summary

Constructors

Constructor and Description
NettyConnection(Client.WithManagement client, @NonNull io.netty.channel.ChannelFuture channelFuture, @NonNull Consumer<Client.WithManagement> shutdownHook) Constructs a Netty connection.

Method Summary

Modifier and Type	Method and Description
boolean	isAlive() Gets if the connection is alive.
void	shutdown(DefaultMessageType messageType, boolean reconnect) Shuts down with a message type.
void	shutdown(@Nullable String message, boolean reconnect) Shuts down with a message.
void	startPing() Starts sending pings.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyConnection

public NettyConnection(Client.WithManagement client,
                       @NonNull io.netty.channel.ChannelFuture channelFuture,
                       @NonNull Consumer<Client.WithManagement> shutdownHook)

Constructs a Netty connection.

Parameters:

client - client for which this exists

channelFuture - channel future from which to handle the connection

shutdownHook - consumer to call when shut down

Method Detail

isAlive

public boolean isAlive()

Description copied from interface: ClientConnection

Gets if the connection is alive.

Specified by:

isAlive in interface ClientConnection

Returns:

true if alive

startPing

public void startPing()

Description copied from interface: ClientConnection

Starts sending pings.

Specified by:

startPing in interface ClientConnection

shutdown

public void shutdown(DefaultMessageType messageType,
                     boolean reconnect)

Description copied from interface: ClientConnection

Shuts down with a message type.

Specified by:

shutdown in interface ClientConnection

Parameters:

messageType - message type

reconnect - true to indicate desire to reconnect

shutdown

public void shutdown(@Nullable String message,
                     boolean reconnect)

Description copied from interface: ClientConnection

Shuts down with a message.

Specified by:

shutdown in interface ClientConnection

Parameters:

message - message

reconnect - true to indicate desire to reconnect

toString

public @NonNull String toString()

Overrides:

toString in class Object