org.jivesoftware.smack

Interface ConnectionListener

All Known Implementing Classes:

AbstractConnectionClosedListener, AbstractConnectionListener

public interface ConnectionListener

Interface that allows for implementing classes to listen for connection closing and reconnection events. Listeners are registered with XMPPConnection objects.

Author:

Matt Tucker

See Also:

XMPPConnection.addConnectionListener(org.jivesoftware.smack.ConnectionListener), XMPPConnection.removeConnectionListener(org.jivesoftware.smack.ConnectionListener)

Method Summary

Modifier and Type	Method and Description
void	authenticated(XMPPConnection connection, boolean resumed) Notification that the connection has been authenticated.
void	connected(XMPPConnection connection) Notification that the connection has been successfully connected to the remote endpoint (e.g.
void	connectionClosed() Notification that the connection was closed normally.
void	connectionClosedOnError(Exception e) Notification that the connection was closed due to an exception.
void	reconnectingIn(int seconds) The connection will retry to reconnect in the specified number of seconds.
void	reconnectionFailed(Exception e) An attempt to connect to the server has failed.
void	reconnectionSuccessful() The connection has reconnected successfully to the server.

Method Detail

connected

void connected(XMPPConnection connection)

Notification that the connection has been successfully connected to the remote endpoint (e.g. the XMPP server).

Note that the connection is likely not yet authenticated and therefore only limited operations like registering an account may be possible.

Parameters:

connection - the XMPPConnection which successfully connected to its endpoint.

authenticated

void authenticated(XMPPConnection connection,
                   boolean resumed)

Notification that the connection has been authenticated.

Parameters:

connection - the XMPPConnection which successfully authenticated.

resumed - true if a previous XMPP session's stream was resumed.

connectionClosed

void connectionClosed()

Notification that the connection was closed normally.

connectionClosedOnError

void connectionClosedOnError(Exception e)

Notification that the connection was closed due to an exception. When abruptly disconnected it is possible for the connection to try reconnecting to the server.

Parameters:

e - the exception.

reconnectionSuccessful

void reconnectionSuccessful()

The connection has reconnected successfully to the server. Connections will reconnect to the server when the previous socket connection was abruptly closed.

reconnectingIn

void reconnectingIn(int seconds)

The connection will retry to reconnect in the specified number of seconds.

Note: This method is only called if ReconnectionManager.isAutomaticReconnectEnabled() returns true, i.e. only when the reconnection manager is enabled for the connection.

Parameters:

seconds - remaining seconds before attempting a reconnection.

reconnectionFailed

void reconnectionFailed(Exception e)

An attempt to connect to the server has failed. The connection will keep trying reconnecting to the server in a moment.

Note: This method is only called if ReconnectionManager.isAutomaticReconnectEnabled() returns true, i.e. only when the reconnection manager is enabled for the connection.

Parameters:

e - the exception that caused the reconnection to fail.