org.kitteh.irc.client.library.event.connection

Class ClientConnectionEndedEvent

java.lang.Object

org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

org.kitteh.irc.client.library.event.connection.ClientConnectionEndedEvent

All Implemented Interfaces:

ClientLinked, ClientEvent, ConnectionEvent

Direct Known Subclasses:

ClientConnectionClosedEvent, ClientConnectionFailedEvent

public abstract class ClientConnectionEndedEvent
extends ClientEventBase
implements ConnectionEvent

The Client has had a connection end.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RECONNECTION_DELAY_MILLIS Default reconnection delay, in milliseconds.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientConnectionEndedEvent(@NonNull Client client, boolean canReconnect, @Nullable Throwable cause) Constructs the event.

Method Summary

Modifier and Type	Method and Description
boolean	canAttemptReconnect() Gets if the client will be able to reconnect.
@NonNull Optional<Throwable>	getCause() Gets the exception that caused this disconnect, if there was one.
int	getReconnectionDelay() Gets the delay until reconnection.
void	setAttemptReconnect(boolean reconnecting) Sets if the client will attempt to connect again.
void	setReconnectionDelay(int millis) Sets the delay until a reconnection attempt, in milliseconds.
protected @NonNull ToStringer	toStringer() Generates a partial ToStringer for the command.
boolean	willAttemptReconnect() Gets if the client plans to reconnect to the server.

Methods inherited from class org.kitteh.irc.client.library.event.abstractbase.ClientEventBase

getClient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Field Detail

DEFAULT_RECONNECTION_DELAY_MILLIS

public static final int DEFAULT_RECONNECTION_DELAY_MILLIS

Default reconnection delay, in milliseconds.

See Also:

Constant Field Values

Constructor Detail

ClientConnectionEndedEvent

protected ClientConnectionEndedEvent(@NonNull Client client,
                                     boolean canReconnect,
                                     @Nullable Throwable cause)

Constructs the event.

Parameters:

client - client for which this is occurring

canReconnect - true if the client plans to reconnect

cause - cause, if there was one, closing it

Method Detail

getCause

public @NonNull Optional<Throwable> getCause()

Gets the exception that caused this disconnect, if there was one.

Returns:

exception or empty if no exception

getReconnectionDelay

public int getReconnectionDelay()

Gets the delay until reconnection.

Returns:

reconnection delay, in milliseconds

See Also:

canAttemptReconnect(), willAttemptReconnect(), setAttemptReconnect(boolean)

canAttemptReconnect

public boolean canAttemptReconnect()

Gets if the client will be able to reconnect. This is false if, for instance, the client has been shutdown.

Returns:

true if the client can reconnect

willAttemptReconnect

public boolean willAttemptReconnect()

Gets if the client plans to reconnect to the server.

Returns:

true if the client will attempt to reconnect

setAttemptReconnect

public void setAttemptReconnect(boolean reconnecting)

Sets if the client will attempt to connect again. Note that this will only happen if canAttemptReconnect() is true as the client cannot try to reconnect if it has been shutdown. Setting to true will still result in a false willAttemptReconnect() if it is not able to reconnect.

Parameters:

reconnecting - true to reconnect, false to not reconnect

setReconnectionDelay

public void setReconnectionDelay(int millis)

Sets the delay until a reconnection attempt, in milliseconds.

Parameters:

millis - reconnection delay

Throws:

IllegalArgumentException - if negative

See Also:

canAttemptReconnect(), willAttemptReconnect(), setAttemptReconnect(boolean)

toStringer

protected @NonNull ToStringer toStringer()

Description copied from class: ClientEventBase

Generates a partial ToStringer for the command.

Overrides:

toStringer in class ClientEventBase

Returns:

the partial toString generator