org.pircbotx.hooks.events

Class DisconnectEvent

java.lang.Object

org.pircbotx.hooks.Event

org.pircbotx.hooks.events.DisconnectEvent

All Implemented Interfaces:

Comparable<Event>, GenericEvent, GenericSnapshotEvent

public class DisconnectEvent
extends Event
implements GenericSnapshotEvent

This event is dispatched when we get disconnected. It is meant for the bot to carry out actions upon disconnection. This may happen if the PircBotX quits from the server, or if the connection is unexpectedly lost.

Disconnection from the IRC server is detected immediately if either we or the server close the connection normally. If the connection to the server is lost, but neither we nor the server have explicitly closed the connection, then it may take a few minutes to detect (this is commonly referred to as a "ping timeout").

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
DisconnectEvent(PircBotX bot, UserChannelDaoSnapshot userChannelDaoSnapshot, Exception disconnectException)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
UserChannelDaoSnapshot	getDaoSnapshot() Deprecated. Use getUserChannelDaoSnapshot() from GenericSnapshotEvent
Exception	getDisconnectException() Exception encountered during disconnection, if any
UserChannelDaoSnapshot	getUserChannelDaoSnapshot() Snapshot of the UserChannelDao data before the event.
int	hashCode()
void	respond(String response) Deprecated.
String	toString()

Methods inherited from class org.pircbotx.hooks.Event

compareTo, getBot, getId, getTimestamp

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DisconnectEvent

public DisconnectEvent(PircBotX bot,
                       UserChannelDaoSnapshot userChannelDaoSnapshot,
                       Exception disconnectException)

Method Detail

getDaoSnapshot

@Deprecated
public UserChannelDaoSnapshot getDaoSnapshot()

Deprecated. Use getUserChannelDaoSnapshot() from GenericSnapshotEvent

See Also:

getUserChannelDaoSnapshot(), GenericSnapshotEvent

respond

@Deprecated
public void respond(String response)

Deprecated.

Does NOT respond to the server! This will throw an UnsupportedOperationException since we can't respond to a server we just disconnected from.

Specified by:

respond in interface GenericEvent

Specified by:

respond in class Event

Parameters:

response - The response to send

getDisconnectException

@Generated(value="lombok")
public Exception getDisconnectException()

Exception encountered during disconnection, if any

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Event

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Event

getUserChannelDaoSnapshot

@Generated(value="lombok")
public UserChannelDaoSnapshot getUserChannelDaoSnapshot()

Description copied from interface: GenericSnapshotEvent

Snapshot of the UserChannelDao data before the event.

Specified by:

getUserChannelDaoSnapshot in interface GenericSnapshotEvent

See Also:

Configuration.Builder.setSnapshotsEnabled(boolean)