io.vertx.core.metrics.impl

Class DummyVertxMetrics

java.lang.Object

io.vertx.core.metrics.impl.DummyVertxMetrics

All Implemented Interfaces:

Measured, Metrics, VertxMetrics

public class DummyVertxMetrics
extends Object
implements VertxMetrics

Author:

Tim Fox

Constructor Summary

Constructors

Constructor and Description
DummyVertxMetrics()

Method Summary

Modifier and Type	Method and Description
void	close() Used to close out the metrics, for example when an http server/client has been closed.
DatagramSocketMetrics	createMetrics(DatagramSocket socket, DatagramSocketOptions options) Provides the datagram/udp metrics SPI when a datagram socket is created
EventBusMetrics	createMetrics(EventBus eventBus) Provides the event bus metrics SPI when the event bus is created
HttpClientMetrics	createMetrics(HttpClient client, HttpClientOptions options) Provides the http client metrics SPI when an http client has been created
HttpServerMetrics	createMetrics(HttpServer server, SocketAddress localAddress, HttpServerOptions options) Provides the http server metrics SPI when an http server is created
TCPMetrics	createMetrics(NetClient client, NetClientOptions options) Provides the net client metrics SPI when a net client is created
TCPMetrics	createMetrics(NetServer server, SocketAddress localAddress, NetServerOptions options) Provides the net server metrics SPI when a net server is created
boolean	isEnabled() Whether the metrics are enabled.
boolean	isMetricsEnabled() Whether the metrics are enabled for this measured object
void	timerCreated(long id) Called when a timer is created
void	timerEnded(long id, boolean cancelled) Called when a timer has ended (setTimer) or has been cancelled.
void	verticleDeployed(Verticle verticle) Called when a verticle is deployed in Vert.x
void	verticleUndeployed(Verticle verticle) Called when a verticle is undeployed in Vert.x

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyVertxMetrics

public DummyVertxMetrics()

Method Detail

verticleDeployed

public void verticleDeployed(Verticle verticle)

Description copied from interface: VertxMetrics

Called when a verticle is deployed in Vert.x

Specified by:

verticleDeployed in interface VertxMetrics

Parameters:

verticle - the verticle which was deployed

verticleUndeployed

public void verticleUndeployed(Verticle verticle)

Description copied from interface: VertxMetrics

Called when a verticle is undeployed in Vert.x

Specified by:

verticleUndeployed in interface VertxMetrics

Parameters:

verticle - the verticle which was undeployed

timerCreated

public void timerCreated(long id)

Description copied from interface: VertxMetrics

Called when a timer is created

Specified by:

timerCreated in interface VertxMetrics

Parameters:

id - the id of the timer

timerEnded

public void timerEnded(long id,
                       boolean cancelled)

Description copied from interface: VertxMetrics

Called when a timer has ended (setTimer) or has been cancelled.

Specified by:

timerEnded in interface VertxMetrics

Parameters:

id - the id of the timer

cancelled - if the timer was cancelled by the user

createMetrics

public EventBusMetrics createMetrics(EventBus eventBus)

Description copied from interface: VertxMetrics

Provides the event bus metrics SPI when the event bus is created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

eventBus - the Vert.x event bus

Returns:

the event bus metrics SPI

createMetrics

public HttpServerMetrics createMetrics(HttpServer server,
                                       SocketAddress localAddress,
                                       HttpServerOptions options)

Description copied from interface: VertxMetrics

Provides the http server metrics SPI when an http server is created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

server - the Vert.x http server

localAddress - localAddress the local address the net socket is listening on

options - the options used to create the HttpServer

Returns:

the http server metrics SPI

createMetrics

public HttpClientMetrics createMetrics(HttpClient client,
                                       HttpClientOptions options)

Description copied from interface: VertxMetrics

Provides the http client metrics SPI when an http client has been created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

client - the Vert.x http client

options - the options used to create the HttpClient

Returns:

the http client metrics SPI

createMetrics

public TCPMetrics createMetrics(NetServer server,
                                SocketAddress localAddress,
                                NetServerOptions options)

Description copied from interface: VertxMetrics

Provides the net server metrics SPI when a net server is created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

server - the Vert.x net server

localAddress - localAddress the local address the net socket is listening on

options - the options used to create the NetServer

Returns:

the net server metrics SPI

createMetrics

public TCPMetrics createMetrics(NetClient client,
                                NetClientOptions options)

Description copied from interface: VertxMetrics

Provides the net client metrics SPI when a net client is created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

client - the Vert.x net client

options - the options used to create the NetClient

Returns:

the net client metrics SPI

createMetrics

public DatagramSocketMetrics createMetrics(DatagramSocket socket,
                                           DatagramSocketOptions options)

Description copied from interface: VertxMetrics

Provides the datagram/udp metrics SPI when a datagram socket is created

Specified by:

createMetrics in interface VertxMetrics

Parameters:

socket - the Vert.x datagram socket

options - the options used to create the DatagramSocket

Returns:

the datagram metrics SPI

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.

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.

isMetricsEnabled

public boolean isMetricsEnabled()

Description copied from interface: Measured

Whether the metrics are enabled for this measured object

Specified by:

isMetricsEnabled in interface Measured

Returns:

true if the metrics are enabled