/*
* Copyright (c) 2011-2015 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;
/**
* An SPI used internally by Vert.x to gather metrics on pools used by Vert.x (execute blocking, worker verticle or data source).
* <p>
* Usually these metrics measure the latency of a task queuing and the latency a task execution.
*
* @author <a href="http://escoffier.me">Clement Escoffier</a>
*/
public interface PoolMetrics<T> extends Metrics {
/**
* A new task has been submitted to access the resource.
* This method is called from the submitter context.
*
* @return the timer measuring the task queuing
*/
T submitted();
/**
* The submitted task start to use the resource.
*
* @param t the timer measuring the task queuing returned by {@link #submitted()}
* @return the timer measuring the task execution
*/
T begin(T t);
/**
* The task has been rejected. The underlying resource has probably be shutdown.
*
* @param t the timer measuring the task queuing returned by {@link #submitted()}
*/
void rejected(T t);
/**
* The submitted tasks has completed its execution and release the resource.
*
* @param succeeded whether or not the task has gracefully completed
* @param t the timer measuring the task execution returned by {@link #begin}
*/
void end(T t, boolean succeeded);
}