DummyVertxMetrics (Vert.x Core 3.0.0 API)

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DummyVertxMetrics.DummyDatagramMetrics`
`protected class`	`DummyVertxMetrics.DummyEventBusMetrics`
`protected class`	`DummyVertxMetrics.DummyHttpClientMetrics`
`protected class`	`DummyVertxMetrics.DummyHttpServerMetrics`
`protected class`	`DummyVertxMetrics.DummyTCPMetrics`

Constructor Summary

Constructors
Constructor and Description

DummyVertxMetrics()

Constructors
Constructor and Description
`DummyVertxMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`DatagramSocketMetrics`	`createMetrics(DatagramSocket socket, DatagramSocketOptions options)` Provides the datagram/udp metrics SPI when a datagram socket is created. No specific thread and context can be expected when this method is called.
`EventBusMetrics`	`createMetrics(EventBus eventBus)` Provides the event bus metrics SPI when the event bus is created. No specific thread and context can be expected when this method is called. This method should be called only once.
`HttpClientMetrics`	`createMetrics(HttpClient client, HttpClientOptions options)` Provides the http client metrics SPI when an http client has been created. No specific thread and context can be expected when this method is called.
`HttpServerMetrics`	`createMetrics(HttpServer server, SocketAddress localAddress, HttpServerOptions options)` Provides the http server metrics SPI when an http server is created. No specific thread and context can be expected when this method is called. Note: this method can be called more than one time for the same `localAddress` when a server is scaled, it is the responsibility of the metrics implementation to eventually merge metrics.
`TCPMetrics`	`createMetrics(NetClient client, NetClientOptions options)` Provides the net client metrics SPI when a net client is created. No specific thread and context can be expected when this method is called.
`TCPMetrics`	`createMetrics(NetServer server, SocketAddress localAddress, NetServerOptions options)` Provides the net server metrics SPI when a net server is created. No specific thread and context can be expected when this method is called. Note: this method can be called more than one time for the same `localAddress` when a server is scaled, it is the responsibility of the metrics implementation to eventually merge metrics.
`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 No specific thread and context can be expected when this method is called.
`void`	`timerEnded(long id, boolean cancelled)` Called when a timer has ended (setTimer) or has been cancelled. No specific thread and context can be expected when this method is called.
`void`	`verticleDeployed(Verticle verticle)` Called when a verticle is deployed in Vert.x . This method is invoked with `Context` and thread of the deployed verticle and therefore might be different on every invocation.
`void`	`verticleUndeployed(Verticle verticle)` Called when a verticle is undeployed in Vert.x . This method is invoked with `Context` and thread of the deployed verticle and therefore might be different on every invocation, however these are the same than the `VertxMetrics.verticleDeployed(io.vertx.core.Verticle)` invocation.

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 .
    This method is invoked with Context and thread of the deployed verticle and therefore might be different on every invocation.
    
    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 .
    This method is invoked with Context and thread of the deployed verticle and therefore might be different on every invocation, however these are the same than the VertxMetrics.verticleDeployed(io.vertx.core.Verticle) invocation.
    
    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 No specific thread and context can be expected when this method is called.
    
    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.
    No specific thread and context can be expected when this method is called.
    
    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.
    No specific thread and context can be expected when this method is called.
    This method should be called only once.
    
    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.
    No specific thread and context can be expected when this method is called.
    Note: this method can be called more than one time for the same localAddress when a server is scaled, it is the responsibility of the metrics implementation to eventually merge metrics. In this case the provided server argument can be used to distinguish the different HttpServerMetrics instances.
    
    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.
    No specific thread and context can be expected when this method is called.
    
    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.
    No specific thread and context can be expected when this method is called.
    Note: this method can be called more than one time for the same localAddress when a server is scaled, it is the responsibility of the metrics implementation to eventually merge metrics. In this case the provided server argument can be used to distinguish the different TCPMetrics instances.
    
    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.
    No specific thread and context can be expected when this method is called.
    
    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.
    No specific thread and context can be expected when this method is called.
    
    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.
    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.
  - 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

Class DummyVertxMetrics

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DummyVertxMetrics

Method Detail

verticleDeployed

verticleUndeployed

timerCreated

timerEnded

createMetrics

createMetrics

createMetrics

createMetrics

createMetrics

createMetrics

close

isEnabled

isMetricsEnabled