• Home
• org.avaje.metric
• avaje-metric-api
• 5.1.1
• source code
• TimedEvent.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.avaje.metric.TimedEvent Maven / Gradle / Ivy

package org.avaje.metric;

/**
 * A TimedEvent that is ended with either success or error.
 * 

 * Note that it is generally preferred to use {@link TimedMetric#addEventSince(boolean, long)} as
 * that avoids an object creation and the associated GC so has slightly less overhead.
 * 

 * Example:
 * 
 * 
 * 
 *  TimedMetric metric = MetricManager.getTimedMetric(MyService.class, "sayHello");
 *  ...
 *  
 *  TimedEvent timedEvent = metric.startEvent();
 *  try {
 *    ...
 *  
 *  } finally {
 *    // Add the event to the 'success' statistics
 *    timedEvent.endWithSuccess();
 *  }
 *  
 * 
 * 
 * 
 * @see TimedMetric#startEvent()
 */
public interface TimedEvent {

  /**
   * End specifying whether the event was successful or in error.
   */
  void end(boolean withSuccess);

  /**
   * This timed event ended with successful execution (e.g. Successful SOAP Operation or SQL
   * execution).
   */
  void endWithSuccess();

  /**
   * This timed event ended with an error or fault execution (e.g. SOAP Fault or SQL exception).
   */
  void endWithError();

}