io.reactivex.netty.metrics

Interface MetricEventsListener<E extends MetricsEvent<?>>

Type Parameters:

E - The type of MetricsEvent this listener listens.

All Known Subinterfaces:

CompositeHttpClientBuilder.CloneablePoolLimitDeterminationStrategy, PoolLimitDeterminationStrategy

All Known Implementing Classes:

ClientMetricEventsListener, CompositePoolLimitDeterminationStrategy, HttpClientMetricEventsListener, HttpServerMetricEventsListener, MaxConnectionsBasedStrategy, MetricEventsSubject, NoOpChannelMetricEventProvider.NoOpMetricEventsSubject, ServerMetricEventsListener, WebSocketClientMetricEventsListener, WebSocketServerMetricEventsListener

public interface MetricEventsListener<E extends MetricsEvent<?>>

A contract to listen for events based on which all metrics can be calculated.

Multiple Subscriptions

Theoretically one can register the same listener instance to multiple MetricEventsPublishers, however in that case, there will be multiple callbacks to onSubscribe() and onCompleted()

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_DURATION
static java.lang.Throwable	NO_ERROR
static java.util.concurrent.TimeUnit	NO_TIME_UNIT
static java.lang.Object	NO_VALUE

Method Summary

Modifier and Type	Method and Description
void	onCompleted() Marks the end of all event callbacks.
void	onEvent(E event, long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable, java.lang.Object value) Event callback for any MetricsEvent.
void	onSubscribe() A callback when this listener is subscribed to a MetricEventsPublisher.

Field Detail

NO_DURATION

static final int NO_DURATION

See Also:

Constant Field Values

NO_VALUE

static final java.lang.Object NO_VALUE

NO_ERROR

static final java.lang.Throwable NO_ERROR

NO_TIME_UNIT

static final java.util.concurrent.TimeUnit NO_TIME_UNIT

Method Detail

onEvent

void onEvent(E event,
             long duration,
             java.util.concurrent.TimeUnit timeUnit,
             java.lang.Throwable throwable,
             java.lang.Object value)

Event callback for any MetricsEvent. The parameters passed are all the contextual information possible for any event. There presence or absence will depend on the type of event.

Parameters:

event - Event for which this callback has been invoked. This will never be null

duration - If the passed event is MetricsEvent.isTimed() then the actual duration, else NO_DURATION

timeUnit - The time unit for the duration, if exists, else NO_TIME_UNIT

throwable - If the passed event is MetricsEvent.isError() then the cause of the error, else NO_ERROR

value - If the passed event requires custom object to be passed, then that object, else NO_VALUE

onCompleted

void onCompleted()

Marks the end of all event callbacks. No methods on this listener will ever be called once this method is called.

onSubscribe

void onSubscribe()

A callback when this listener is subscribed to a MetricEventsPublisher.