io.reactivex.netty.metrics

Class ServerMetricEventsListener<T extends ServerMetricsEvent<?>>

java.lang.Object

io.reactivex.netty.metrics.ServerMetricEventsListener<T>

All Implemented Interfaces:

MetricEventsListener<T>

Direct Known Subclasses:

HttpServerMetricEventsListener, WebSocketServerMetricEventsListener

public abstract class ServerMetricEventsListener<T extends ServerMetricsEvent<?>>
extends java.lang.Object
implements MetricEventsListener<T>

A convenience implementation for MetricEventsListener for receiving ServerMetricsEvent. This implementation receives the events and provides convenience methods representing those events with clear arguments that are expected with that event type.

Field Summary

Fields inherited from interface io.reactivex.netty.metrics.MetricEventsListener

NO_DURATION, NO_ERROR, NO_TIME_UNIT, NO_VALUE

Constructor Summary

Constructors

Constructor and Description
ServerMetricEventsListener()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	onByteRead(long bytesRead)
void	onCompleted() Marks the end of all event callbacks.
protected void	onConnectionCloseFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable)
protected void	onConnectionCloseStart()
protected void	onConnectionCloseSuccess(long duration, java.util.concurrent.TimeUnit timeUnit)
protected void	onConnectionHandlingFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable)
protected void	onConnectionHandlingStart(long duration, java.util.concurrent.TimeUnit timeUnit)
protected void	onConnectionHandlingSuccess(long duration, java.util.concurrent.TimeUnit timeUnit)
void	onEvent(T event, long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable, java.lang.Object value) Event callback for any MetricsEvent.
protected void	onFlushFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable)
protected void	onFlushStart()
protected void	onFlushSuccess(long duration, java.util.concurrent.TimeUnit timeUnit)
protected void	onNewClientConnected()
void	onSubscribe() A callback when this listener is subscribed to a MetricEventsPublisher.
protected void	onWriteFailed(long duration, java.util.concurrent.TimeUnit timeUnit, java.lang.Throwable throwable)
protected void	onWriteStart()
protected void	onWriteSuccess(long duration, java.util.concurrent.TimeUnit timeUnit, long bytesWritten)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerMetricEventsListener

public ServerMetricEventsListener()

Method Detail

onEvent

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

Description copied from interface: MetricEventsListener

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.

Specified by:

onEvent in interface MetricEventsListener<T extends ServerMetricsEvent<?>>

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 MetricEventsListener.NO_DURATION

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

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

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

onConnectionHandlingFailed

protected void onConnectionHandlingFailed(long duration,
                              java.util.concurrent.TimeUnit timeUnit,
                              java.lang.Throwable throwable)

onConnectionHandlingSuccess

protected void onConnectionHandlingSuccess(long duration,
                               java.util.concurrent.TimeUnit timeUnit)

onConnectionHandlingStart

protected void onConnectionHandlingStart(long duration,
                             java.util.concurrent.TimeUnit timeUnit)

onConnectionCloseStart

protected void onConnectionCloseStart()

onConnectionCloseSuccess

protected void onConnectionCloseSuccess(long duration,
                            java.util.concurrent.TimeUnit timeUnit)

onConnectionCloseFailed

protected void onConnectionCloseFailed(long duration,
                           java.util.concurrent.TimeUnit timeUnit,
                           java.lang.Throwable throwable)

onNewClientConnected

protected void onNewClientConnected()

onByteRead

protected void onByteRead(long bytesRead)

onFlushFailed

protected void onFlushFailed(long duration,
                 java.util.concurrent.TimeUnit timeUnit,
                 java.lang.Throwable throwable)

onFlushSuccess

protected void onFlushSuccess(long duration,
                  java.util.concurrent.TimeUnit timeUnit)

onFlushStart

protected void onFlushStart()

onWriteFailed

protected void onWriteFailed(long duration,
                 java.util.concurrent.TimeUnit timeUnit,
                 java.lang.Throwable throwable)

onWriteSuccess

protected void onWriteSuccess(long duration,
                  java.util.concurrent.TimeUnit timeUnit,
                  long bytesWritten)

onWriteStart

protected void onWriteStart()

onCompleted

public void onCompleted()

Description copied from interface: MetricEventsListener

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

Specified by:

onCompleted in interface MetricEventsListener<T extends ServerMetricsEvent<?>>

onSubscribe

public void onSubscribe()

Description copied from interface: MetricEventsListener

A callback when this listener is subscribed to a MetricEventsPublisher.

Specified by:

onSubscribe in interface MetricEventsListener<T extends ServerMetricsEvent<?>>