com.spotify.folsom.reconnect

Interface ReconnectionListener

All Known Implementing Classes:

AbstractReconnectionListener, CatchingReconnectionListener, ReconnectingClient.StandardReconnectionListener

public interface ReconnectionListener

A listener for each reconnection event. This will be called more often than the ConnectionChangeListeners.

If you implement this interface manually, expect there to be changes in minor versions which can cause source-incompatibility. If you want to implement this interface without this hassle, extend AbstractReconnectionListener instead.

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.

Method Detail

connectionFailure

void connectionFailure(java.lang.Throwable cause)

A connection to Memcached was attempted, but ultimately failed.

Parameters:

cause - why the connection failed, never null

reconnectionCancelled

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.

reconnectionSuccessful

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

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

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

connectionLost

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.

Parameters:

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

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

reconnectionQueuedFromError

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.

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)