com.spotify.folsom.reconnect

Class ReconnectingClient.StandardReconnectionListener

java.lang.Object

com.spotify.folsom.reconnect.AbstractReconnectionListener

com.spotify.folsom.reconnect.ReconnectingClient.StandardReconnectionListener

All Implemented Interfaces:

ReconnectionListener

Enclosing class:

ReconnectingClient

public static class ReconnectingClient.StandardReconnectionListener
extends AbstractReconnectionListener

This class should be regarded as internal API. We recognise it may be useful outside internals, to which end it is exposed. All methods are unstable and can change with breakage in patch versions. If you just want your own listener with a stable API, you could extend AbstractReconnectionListener yourself and delegate calls to this.

Constructor Summary

Constructors

Constructor and Description
StandardReconnectionListener()

Method Summary

Modifier and Type	Method and Description
void	connectionLost(java.lang.Throwable cause, HostAndPort address) A connection to Memcached was lost after having been acquired.
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 com.spotify.folsom.reconnect.AbstractReconnectionListener

connectionFailure, reconnectionCancelled

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardReconnectionListener

public StandardReconnectionListener()

Method Detail

connectionLost

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

Description copied from class: AbstractReconnectionListener

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

Overrides:

connectionLost in class AbstractReconnectionListener

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)

Description copied from class: AbstractReconnectionListener

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

Specified by:

reconnectionSuccessful in interface ReconnectionListener

Overrides:

reconnectionSuccessful in class AbstractReconnectionListener

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

reconnectionQueuedFromError

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

Description copied from class: AbstractReconnectionListener

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

Overrides:

reconnectionQueuedFromError in class AbstractReconnectionListener

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)