com.spotify.folsom.reconnect

Class CatchingReconnectionListener

java.lang.Object

com.spotify.folsom.reconnect.CatchingReconnectionListener

All Implemented Interfaces:

ReconnectionListener

public class CatchingReconnectionListener
extends java.lang.Object
implements ReconnectionListener

A ReconnectionListener which ensures the methods never throw Exception (though Error and Throwable are not caught).

This should wrap any untrusted ReconnectionListener.

This class should be regarded as internal API. We recognise it may be useful outside internals, to which end it is exposed. The constructor is stable. All methods are unstable and can change with breakage in patch versions. If you want a stable interface, wrap your own reconnection listener in this, instead of extending it (and instead extend AbstractReconnectionListener).

Field Summary

Fields

Modifier and Type	Field and Description
private ReconnectionListener	delegate
private static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
CatchingReconnectionListener(ReconnectionListener delegate)

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.
boolean	equals(java.lang.Object o)
int	hashCode()
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final org.slf4j.Logger log

delegate

private final ReconnectionListener delegate

Constructor Detail

CatchingReconnectionListener

public CatchingReconnectionListener(ReconnectionListener delegate)

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

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

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

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

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)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object