/*
* Copyright (c) 2011-2014 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.core.spi.metrics;
import io.vertx.core.http.HttpMethod;
import io.vertx.core.http.HttpServerRequest;
import io.vertx.core.http.HttpServerResponse;
import io.vertx.core.http.ServerWebSocket;
/**
* The http server metrics SPI that Vert.x will use to call when each http server event occurs.<p/>
*
* The thread model for the http server metrics depends on the actual context thats started the server.<p/>
*
* <h3>Event loop context</h3>
*
* 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
* {@link io.vertx.core.spi.metrics.VertxMetrics} {@code createMetrics} method that created and returned
* this metrics object.
*
* <h3>Worker context</h3>
*
* Unless specified otherwise, all the methods on this object including the methods inherited from the super interfaces are invoked
* with a worker thread.
*
* @author <a href="mailto:nscavell@redhat.com">Nick Scavelli</a>
*/
public interface HttpServerMetrics<R, W, S> extends TCPMetrics<S> {
/**
* Called when an http server request begins. Vert.x will invoke {@link #responseEnd} when the response has ended
* or {@link #requestReset} if the request/response has failed before.
*
* @param socketMetric the socket metric
* @param request the http server reuqest
* @return the request metric
*/
R requestBegin(S socketMetric, HttpServerRequest request);
/**
* Called when the http server request couldn't complete successfully, for instance the connection
* was closed before the response was sent.
*
* @param requestMetric the request metric
*/
void requestReset(R requestMetric);
/**
* Called when an http server response is pushed.
*
* @param socketMetric the socket metric
* @param method the pushed response method
* @param uri the pushed response uri
* @param response the http server response @return the request metric
*/
R responsePushed(S socketMetric, HttpMethod method, String uri, HttpServerResponse response);
/**
* Called when an http server response has ended.
*
* @param requestMetric the request metric
* @param response the http server request
*/
void responseEnd(R requestMetric, HttpServerResponse response);
/**
* Called when an http server request is upgrade to a websocket.
*
* @param requestMetric the request metric
* @param serverWebSocket the server web socket
* @return the server web socket metric
*/
W upgrade(R requestMetric, ServerWebSocket serverWebSocket);
/**
* Called when a server web socket connects.
*
* @param socketMetric the socket metric
* @param serverWebSocket the server web socket
* @return the server web socket metric
*/
W connected(S socketMetric, ServerWebSocket serverWebSocket);
/**
* Called when the server web socket has disconnected.
*
* @param serverWebSocketMetric the server web socket metric
*/
void disconnected(W serverWebSocketMetric);
}