Package org.elasticsearch.common.breaker

Class NoopCircuitBreaker

java.lang.Object

org.elasticsearch.common.breaker.NoopCircuitBreaker

All Implemented Interfaces:

CircuitBreaker

public class NoopCircuitBreaker
extends java.lang.Object
implements CircuitBreaker

A CircuitBreaker that doesn't increment or adjust, and all operations are basically noops

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.breaker.CircuitBreaker

CircuitBreaker.Durability, CircuitBreaker.Type

Field Summary

Fields

Modifier and Type	Field	Description
static int	LIMIT

Fields inherited from interface org.elasticsearch.common.breaker.CircuitBreaker

ACCOUNTING, FIELDDATA, IN_FLIGHT_REQUESTS, PARENT, REQUEST

Constructor Summary

Constructors

Constructor	Description
NoopCircuitBreaker(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
double	addEstimateBytesAndMaybeBreak(long bytes, java.lang.String label)	add bytes to the breaker and maybe trip
long	addWithoutBreaking(long bytes)	Adjust the circuit breaker without tripping
void	circuitBreak(java.lang.String fieldName, long bytesNeeded)	Trip the circuit breaker
CircuitBreaker.Durability	getDurability()
long	getLimit()
java.lang.String	getName()
double	getOverhead()
long	getTrippedCount()
long	getUsed()

Methods inherited from class java.lang.Object

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

Field Details

LIMIT

public static final int LIMIT

See Also:

Constant Field Values

Constructor Details

NoopCircuitBreaker

public NoopCircuitBreaker(java.lang.String name)

Method Details

circuitBreak

public void circuitBreak(java.lang.String fieldName, long bytesNeeded)

Description copied from interface: CircuitBreaker

Trip the circuit breaker

Specified by:

circuitBreak in interface CircuitBreaker

Parameters:

fieldName - name of the field responsible for tripping the breaker

bytesNeeded - bytes asked for but unable to be allocated

addEstimateBytesAndMaybeBreak

public double addEstimateBytesAndMaybeBreak(long bytes, java.lang.String label) throws CircuitBreakingException

Description copied from interface: CircuitBreaker

add bytes to the breaker and maybe trip

Specified by:

addEstimateBytesAndMaybeBreak in interface CircuitBreaker

Parameters:

bytes - number of bytes to add

label - string label describing the bytes being added

Returns:

the number of "used" bytes for the circuit breaker

Throws:

CircuitBreakingException

addWithoutBreaking

public long addWithoutBreaking(long bytes)

Description copied from interface: CircuitBreaker

Adjust the circuit breaker without tripping

Specified by:

addWithoutBreaking in interface CircuitBreaker

getUsed

public long getUsed()

Specified by:

getUsed in interface CircuitBreaker

Returns:

the currently used bytes the breaker is tracking

getLimit

public long getLimit()

Specified by:

getLimit in interface CircuitBreaker

Returns:

maximum number of bytes the circuit breaker can track before tripping

getOverhead

public double getOverhead()

Specified by:

getOverhead in interface CircuitBreaker

Returns:

overhead of circuit breaker

getTrippedCount

public long getTrippedCount()

Specified by:

getTrippedCount in interface CircuitBreaker

Returns:

the number of times the circuit breaker has been tripped

getName

public java.lang.String getName()

Specified by:

getName in interface CircuitBreaker

Returns:

the name of the breaker

getDurability

public CircuitBreaker.Durability getDurability()

Specified by:

getDurability in interface CircuitBreaker

Returns:

whether a tripped circuit breaker will reset itself (transient) or requires manual intervention (permanent).