io.vertx.core.metrics.impl

Class DummyVertxMetrics.DummyTCPMetrics

java.lang.Object

io.vertx.core.metrics.impl.DummyVertxMetrics.DummyTCPMetrics

All Implemented Interfaces:

Metrics, NetworkMetrics<Void>, TCPMetrics<Void>

Enclosing class:

DummyVertxMetrics

protected class DummyVertxMetrics.DummyTCPMetrics
extends Object
implements TCPMetrics<Void>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DummyTCPMetrics()

Method Summary

Modifier and Type	Method and Description
void	bytesRead(Void socketMetric, SocketAddress remoteAddress, long numberOfBytes) Called when bytes have been read
void	bytesWritten(Void socketMetric, SocketAddress remoteAddress, long numberOfBytes) Called when bytes have been written
void	close() Used to close out the metrics, for example when an http server/client has been closed. No specific thread and context can be expected when this method is called.
Void	connected(SocketAddress remoteAddress) Called when a client has connected, which is applicable for TCP connections.
void	disconnected(Void socketMetric, SocketAddress remoteAddress) Called when a client has disconnected, which is applicable for TCP connections.
void	exceptionOccurred(Void socketMetric, SocketAddress remoteAddress, Throwable t) Called when exceptions occur for a specific connection.
boolean	isEnabled() Whether the metrics are enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyTCPMetrics

protected DummyTCPMetrics()

Method Detail

connected

public Void connected(SocketAddress remoteAddress)

Description copied from interface: TCPMetrics

Called when a client has connected, which is applicable for TCP connections.

Specified by:

connected in interface TCPMetrics<Void>

Parameters:

remoteAddress - the remote address of the client

Returns:

the socket metric

disconnected

public void disconnected(Void socketMetric,
                         SocketAddress remoteAddress)

Description copied from interface: TCPMetrics

Called when a client has disconnected, which is applicable for TCP connections.

Specified by:

disconnected in interface TCPMetrics<Void>

Parameters:

socketMetric - the socket metric

remoteAddress - the remote address of the client

bytesRead

public void bytesRead(Void socketMetric,
                      SocketAddress remoteAddress,
                      long numberOfBytes)

Description copied from interface: NetworkMetrics

Called when bytes have been read

Specified by:

bytesRead in interface NetworkMetrics<Void>

Parameters:

socketMetric - the socket metric, null for UDP

remoteAddress - the remote address which this socket received bytes from

numberOfBytes - the number of bytes read

bytesWritten

public void bytesWritten(Void socketMetric,
                         SocketAddress remoteAddress,
                         long numberOfBytes)

Description copied from interface: NetworkMetrics

Called when bytes have been written

Specified by:

bytesWritten in interface NetworkMetrics<Void>

Parameters:

socketMetric - the socket metric, null for UDP

remoteAddress - the remote address which bytes are being written to

numberOfBytes - the number of bytes written

exceptionOccurred

public void exceptionOccurred(Void socketMetric,
                              SocketAddress remoteAddress,
                              Throwable t)

Description copied from interface: NetworkMetrics

Called when exceptions occur for a specific connection.

Specified by:

exceptionOccurred in interface NetworkMetrics<Void>

Parameters:

socketMetric - the socket metric, null for UDP

remoteAddress - the remote address of the connection or null if it's datagram/udp

t - the exception that occurred

close

public void close()

Description copied from interface: Metrics

Used to close out the metrics, for example when an http server/client has been closed.

No specific thread and context can be expected when this method is called.

Specified by:

close in interface Metrics

isEnabled

public boolean isEnabled()

Description copied from interface: Metrics

Whether the metrics are enabled.

Specified by:

isEnabled in interface Metrics

Returns:

true if the metrics are enabled.