开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Internet/网络编程 > 网格计算 > 查看源码
MetricsContext.java
资源名称：hadoop-0.20.0.tar.gz　[点击查看]
上传用户：quxuerui
上传日期：2018-01-08
资源大小：41811k
文件大小：3k
源码类别：

网格计算

开发平台：

Java

MetricsContext.java：源码内容
  1. /*
  2.  * MetricsContext.java
  3.  *
  4.  * Licensed to the Apache Software Foundation (ASF) under one
  5.  * or more contributor license agreements.  See the NOTICE file
  6.  * distributed with this work for additional information
  7.  * regarding copyright ownership.  The ASF licenses this file
  8.  * to you under the Apache License, Version 2.0 (the
  9.  * "License"); you may not use this file except in compliance
  10.  * with the License.  You may obtain a copy of the License at
  11.  *
  12.  *     http://www.apache.org/licenses/LICENSE-2.0
  13.  *
  14.  * Unless required by applicable law or agreed to in writing, software
  15.  * distributed under the License is distributed on an "AS IS" BASIS,
  16.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  * See the License for the specific language governing permissions and
  18.  * limitations under the License.
  19.  */
  21. package org.apache.hadoop.metrics;
  23. import java.io.IOException;
  25. /**
  26.  * The main interface to the metrics package. 
  27.  */
  28. public interface MetricsContext {
  29.     
  30.   /**
  31.    * Default period in seconds at which data is sent to the metrics system.
  32.    */
  33.   public static final int DEFAULT_PERIOD = 5;
  35.   /**
  36.    * Initialize this context.
  37.    * @param contextName The given name for this context
  38.    * @param factory The creator of this context
  39.    */
  40.   public void init(String contextName, ContextFactory factory);
  42.   /**
  43.    * Returns the context name.
  44.    *
  45.    * @return the context name
  46.    */
  47.   public abstract String getContextName();
  48.     
  49.   /**
  50.    * Starts or restarts monitoring, the emitting of metrics records as they are 
  51.    * updated. 
  52.    */
  53.   public abstract void startMonitoring()
  54.     throws IOException;
  56.   /**
  57.    * Stops monitoring.  This does not free any data that the implementation
  58.    * may have buffered for sending at the next timer event. It
  59.    * is OK to call <code>startMonitoring()</code> again after calling 
  60.    * this.
  61.    * @see #close()
  62.    */
  63.   public abstract void stopMonitoring();
  64.     
  65.   /**
  66.    * Returns true if monitoring is currently in progress.
  67.    */
  68.   public abstract boolean isMonitoring();
  69.     
  70.   /**
  71.    * Stops monitoring and also frees any buffered data, returning this 
  72.    * object to its initial state.  
  73.    */
  74.   public abstract void close();
  75.     
  76.   /**
  77.    * Creates a new MetricsRecord instance with the given <code>recordName</code>.
  78.    * Throws an exception if the metrics implementation is configured with a fixed
  79.    * set of record names and <code>recordName</code> is not in that set.
  80.    *
  81.    * @param recordName the name of the record
  82.    * @throws MetricsException if recordName conflicts with configuration data
  83.    */
  84.   public abstract MetricsRecord createRecord(String recordName);
  85.     
  86.   /**
  87.    * Registers a callback to be called at regular time intervals, as 
  88.    * determined by the implementation-class specific configuration.
  89.    *
  90.    * @param updater object to be run periodically; it should updated
  91.    * some metrics records and then return
  92.    */
  93.   public abstract void registerUpdater(Updater updater);
  95.   /**
  96.    * Removes a callback, if it exists.
  97.    * 
  98.    * @param updater object to be removed from the callback list
  99.    */
  100.   public abstract void unregisterUpdater(Updater updater);
  101.   
  102.   /**
  103.    * Returns the timer period.
  104.    */
  105.   public abstract int getPeriod();
  106.     
  107. }