PoolStatsProvider.java

/*
   Copyright (c) 2012 LinkedIn Corp.

   Licensed 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.
*/

/**
 * $Id: $
 */

package com.linkedin.r2.transport.http.client;

import java.util.Map;

/**
 * @author Ang Xu
 * @version $Revision: $
 */
public interface PoolStatsProvider
{
  /**
   * Get statistics from each channel pool. The map keys represent pool names.
   * The values are the corresponding {@link PoolStats} objects.
   *
   * @return A map of pool names and statistics.
   */
  Map<String, PoolStats> getPoolStats();

  /**
   * Get the name of {@link PoolStatsProvider}.
   *
   * @return String of provider name.
   */
  String getName();
}