com.spotify.folsom.reconnect

Class AbstractReconnectionListener

java.lang.Object

com.spotify.folsom.reconnect.AbstractReconnectionListener

All Implemented Interfaces:

ReconnectionListener

Direct Known Subclasses:

ReconnectingClient.StandardReconnectionListener

public abstract class AbstractReconnectionListener
extends java.lang.Object
implements ReconnectionListener

A listener for each reconnection event. This will be called more often than the ConnectionChangeListeners. For more information on this, see ReconnectionListener.

This class acts as a stable interface for ReconnectionListener. While ReconnectionListener can have source-incompatible changes in minor versions, this cannot do that.

See Also:

ReconnectionListener

Constructor Summary

Constructors

Constructor and Description
AbstractReconnectionListener()

Method Summary

Modifier and Type	Method and Description
void	connectionFailure(java.lang.Throwable cause) A connection to Memcached was attempted, but ultimately failed.
void	connectionLost(java.lang.Throwable cause, HostAndPort address) A connection to Memcached was lost after having been acquired.
void	reconnectionCancelled() The reconnection was cancelled.
void	reconnectionQueuedFromError(java.lang.Throwable cause, HostAndPort address, long backOffMillis, int attempt) A new reconnection has been queued on the executor.
void	reconnectionSuccessful(HostAndPort address, int attempt, boolean willStayConnected) A reconnect was successful, and a new connection has been set up.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReconnectionListener

public AbstractReconnectionListener()

Method Detail

connectionFailure

public void connectionFailure(java.lang.Throwable cause)

A connection to Memcached was attempted, but ultimately failed.

Specified by:

connectionFailure in interface ReconnectionListener

Parameters:

cause - why the connection failed, never null

connectionLost

public void connectionLost(@Nullable
                           java.lang.Throwable cause,
                           HostAndPort address)

A connection to Memcached was lost after having been acquired.

This will be called regardless of if it was shut down intentionally, or in error.

Specified by:

connectionLost in interface ReconnectionListener

Parameters:

cause - the cause of losing the connection, can be null

address - the address to the Memcached node we were connected, never null

reconnectionSuccessful

public void reconnectionSuccessful(HostAndPort address,
                                   int attempt,
                                   boolean willStayConnected)

A reconnect was successful, and a new connection has been set up.

Specified by:

reconnectionSuccessful in interface ReconnectionListener

Parameters:

address - the address to which the client connected, never null

attempt - which attempt it succeeded on; this is 1-indexed (i.e. 1st attempt is 1, 2nd is 2)

willStayConnected - whether the connection will immediately close after this, often due to race conditions

reconnectionCancelled

public void reconnectionCancelled()

The reconnection was cancelled. This can be because the client was shut down between the connection and clean up upon a retry, or because a connection couldn't be acquired to begin with.

Specified by:

reconnectionCancelled in interface ReconnectionListener

reconnectionQueuedFromError

public void reconnectionQueuedFromError(java.lang.Throwable cause,
                                        HostAndPort address,
                                        long backOffMillis,
                                        int attempt)

A new reconnection has been queued on the executor. This is done after a failure occurred.

If the client is shut down between this call and the actual connection, you will never see a follow-up to any success or failure method.

Specified by:

reconnectionQueuedFromError in interface ReconnectionListener

Parameters:

cause - the cause of the reconnection, i.e. "what failed to cause this?", never null

address - the address to the Memcached node we will connect to, never null

backOffMillis - how many milliseconds we will wait before we attempt again, never null

attempt - which attempt we are on; this is 1-indexed (i.e. 1st attempt is 1, 2nd is 2)