io.sentry.connection

Class LockdownManager

java.lang.Object

io.sentry.connection.LockdownManager

public class LockdownManager
extends Object

Abstracts the connection lockdown logic (and state) to a single place so that it's easier to understand.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_BASE_LOCKDOWN_TIME Default base duration for a lockdown.
static long	DEFAULT_MAX_LOCKDOWN_TIME Default maximum duration for a lockdown.

Constructor Summary

Constructors

Constructor and Description
LockdownManager() Construct a LockdownManager using the default system clock.
LockdownManager(Clock clock) Construct a LockdownManager using the provided clock.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isLockedDown() Returns true if the system is in a lockdown.
void	resetState() Reset the lockdown state, disabling lockdown and setting the backoff time to zero.
void	setBaseLockdownTime(long baseLockdownTime)
void	setMaxLockdownTime(long maxLockdownTime)
void	setState(ConnectionException connectionException) Enable lockdown if it's not already enabled, using the recommended time from the provided ConnectionException, if any.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_LOCKDOWN_TIME

public static final long DEFAULT_MAX_LOCKDOWN_TIME

Default maximum duration for a lockdown.

DEFAULT_BASE_LOCKDOWN_TIME

public static final long DEFAULT_BASE_LOCKDOWN_TIME

Default base duration for a lockdown.

Constructor Detail

LockdownManager

public LockdownManager()

Construct a LockdownManager using the default system clock.

LockdownManager

public LockdownManager(Clock clock)

Construct a LockdownManager using the provided clock.

Parameters:

clock - Clock object to use for lockdown logic

Method Detail

isLockedDown

public boolean isLockedDown()

Returns true if the system is in a lockdown.

Returns:

true if the system is in a lockdown, otherwise false

resetState

public void resetState()

Reset the lockdown state, disabling lockdown and setting the backoff time to zero.

setState

public void setState(ConnectionException connectionException)

Enable lockdown if it's not already enabled, using the recommended time from the provided ConnectionException, if any.

Parameters:

connectionException - ConnectionException to check for a recommended lockdown time, may be null

setBaseLockdownTime

public void setBaseLockdownTime(long baseLockdownTime)

setMaxLockdownTime

public void setMaxLockdownTime(long maxLockdownTime)