Package com.couchbase.client.core

Class BackpressureException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.couchbase.client.core.CouchbaseException

com.couchbase.client.core.BackpressureException

All Implemented Interfaces:

Serializable

public class BackpressureException
extends CouchbaseException

Identifies the need to back off on the supplier side when using a service, because the consumer is overloaded.

Since:

1.0

Author:

Michael Nitschinger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BackpressureException()
BackpressureException(RingBufferDiagnostics diagnostics)

Method Summary

Modifier and Type	Method	Description
RingBufferDiagnostics	diagnostics()	Returns a RingBufferDiagnostics which, if non-null, gives a granular breakdown of the contents of the ringbuffer at the time of this exception
String	toString()

Methods inherited from class com.couchbase.client.core.CouchbaseException

details, details, getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

BackpressureException

public BackpressureException()

BackpressureException

public BackpressureException(RingBufferDiagnostics diagnostics)

Method Detail

diagnostics

@Public
@Experimental
public RingBufferDiagnostics diagnostics()

Returns a RingBufferDiagnostics which, if non-null, gives a granular breakdown of the contents of the ringbuffer at the time of this exception

Returns:

returns the diagnostics for the ringbuffer where the backpressure originated.

toString

public String toString()

Overrides:

toString in class Throwable