net.logstash.logback.appender.destination

Class DestinationConnectionStrategyWithTtl

java.lang.Object

net.logstash.logback.appender.destination.DestinationConnectionStrategyWithTtl

All Implemented Interfaces:

DestinationConnectionStrategy

Direct Known Subclasses:

RandomDestinationConnectionStrategy, RoundRobinDestinationConnectionStrategy

public abstract class DestinationConnectionStrategyWithTtl
extends Object
implements DestinationConnectionStrategy

A DestinationConnectionStrategy that will force a connection to be reestablished after a length of time has elapsed.

Constructor Summary

Constructors

Constructor and Description
DestinationConnectionStrategyWithTtl()

Method Summary

Methods

Modifier and Type	Method and Description
void	connectFailed(long connectionStartTimeInMillis, int failedDestinationIndex, int numDestinations) Called when a connection fails to the given failedDestinationIndex.
void	connectSuccess(long connectionStartTimeInMillis, int connectedDestinationIndex, int numDestinations) Called when a connection was successful to the given connectedDestinationIndex.
ch.qos.logback.core.util.Duration	getConnectionTTL()
void	setConnectionTTL(ch.qos.logback.core.util.Duration connectionTTL)
boolean	shouldReconnect(long currentTimeInMillis, int currentDestinationIndex, int numDestinations) Returns whether the connection should be reestablished.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.logstash.logback.appender.destination.DestinationConnectionStrategy

selectNextDestinationIndex

Constructor Detail

DestinationConnectionStrategyWithTtl

public DestinationConnectionStrategyWithTtl()

Method Detail

connectSuccess

public void connectSuccess(long connectionStartTimeInMillis,
                  int connectedDestinationIndex,
                  int numDestinations)

Description copied from interface: DestinationConnectionStrategy

Called when a connection was successful to the given connectedDestinationIndex.

Specified by:

connectSuccess in interface DestinationConnectionStrategy

Parameters:

connectionStartTimeInMillis - The time in millis at which the connection was initiated (not completed).

connectedDestinationIndex - The index of the destination which was successfully connected.

numDestinations - The total number of destinations available.

connectFailed

public void connectFailed(long connectionStartTimeInMillis,
                 int failedDestinationIndex,
                 int numDestinations)

Description copied from interface: DestinationConnectionStrategy

Called when a connection fails to the given failedDestinationIndex.

Specified by:

connectFailed in interface DestinationConnectionStrategy

Parameters:

connectionStartTimeInMillis - The time in millis at which the connection was initiated (not completed).

failedDestinationIndex - The index of the destination which failed to connect.

numDestinations - The total number of destinations available.

shouldReconnect

public boolean shouldReconnect(long currentTimeInMillis,
                      int currentDestinationIndex,
                      int numDestinations)

Description copied from interface: DestinationConnectionStrategy

Returns whether the connection should be reestablished.

Specified by:

shouldReconnect in interface DestinationConnectionStrategy

Parameters:

currentTimeInMillis - The time in millis for which to reevaluate whether the connection should be reestablished.

currentDestinationIndex - The index of the destination which is currently connected

numDestinations - The total number of destinations available.

Returns:

true if the connection should be reestablished (to the destination returned by the next call to DestinationConnectionStrategy.selectNextDestinationIndex(int, int), false otherwise.

getConnectionTTL

public ch.qos.logback.core.util.Duration getConnectionTTL()

setConnectionTTL

public void setConnectionTTL(ch.qos.logback.core.util.Duration connectionTTL)