HOpTimer.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.datastax.drivers.jdbc.pool.cassandra.connection;

/**
 * Timer For Cassandra operations
 */
public interface HOpTimer {

  /**
   * Start timing an operation.
   * 
   * @return - a token that will be returned to the timer when stop(...) in
   *         invoked
   */
  Object start();

  /**
   * 
   * @param token
   *          - the token returned from start
   * @param tagName
   *          - the name of the tag
   * @param success
   *          - did the oepration succeed
   */
  void stop(Object token, String tagName, boolean success);
}