io.vertx.core.spi.metrics

Interface HttpServerMetrics<R,W,S>

All Superinterfaces:

Metrics, NetworkMetrics<S>, TCPMetrics<S>

All Known Implementing Classes:

DummyVertxMetrics.DummyHttpServerMetrics

public interface HttpServerMetrics<R,W,S>
extends TCPMetrics<S>

The http server metrics SPI that Vert.x will use to call when each http server event occurs.

The thread model for the http server metrics depends on the actual context thats started the server.

Event loop context

Unless specified otherwise, all the methods on this object including the methods inherited from the super interfaces are invoked with the thread of the http server and therefore are the same than the VertxMetrics createMetrics method that created and returned this metrics object.

Worker context

Unless specified otherwise, all the methods on this object including the methods inherited from the super interfaces are invoked with a worker thread.

Author:

Nick Scavelli

Method Summary

Modifier and Type	Method and Description
W	connected(S socketMetric, ServerWebSocket serverWebSocket) Called when a server web socket connects.
void	disconnected(W serverWebSocketMetric) Called when the server web socket has disconnected.
R	requestBegin(S socketMetric, HttpServerRequest request) Called when an http server request begins
void	responseEnd(R requestMetric, HttpServerResponse response) Called when an http server response has ended.

Methods inherited from interface io.vertx.core.spi.metrics.TCPMetrics

connected, disconnected

Methods inherited from interface io.vertx.core.spi.metrics.NetworkMetrics

bytesRead, bytesWritten, exceptionOccurred

Methods inherited from interface io.vertx.core.spi.metrics.Metrics

close, isEnabled

Method Detail

requestBegin

R requestBegin(S socketMetric,
               HttpServerRequest request)

Called when an http server request begins

Parameters:

socketMetric - the socket metric

request - the HttpServerRequest

Returns:

the request metric

responseEnd

void responseEnd(R requestMetric,
                 HttpServerResponse response)

Called when an http server response has ended.

Parameters:

requestMetric - the request metric

response - the HttpServerResponse

connected

W connected(S socketMetric,
            ServerWebSocket serverWebSocket)

Called when a server web socket connects.

Parameters:

socketMetric - the socket metric

serverWebSocket - the server web socket

Returns:

the server web socket metric

disconnected

void disconnected(W serverWebSocketMetric)

Called when the server web socket has disconnected.

Parameters:

serverWebSocketMetric - the server web socket metric