1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 package org.apache.giraph.comm.netty; 20 21 22 /** ByteCounter interface */ 23 public interface ByteCounter { 24 /** 25 * Reset everything this object keeps track of 26 */ 27 void resetAll(); 28 29 /** 30 * @return A string containing all the metrics 31 */ 32 String getMetrics(); 33 34 /** 35 * Get the metrics if a given window of time has passed. Return null 36 * otherwise. If the window is met, reset the metrics. 37 * 38 * @param minMsecsWindow Msecs of the minimum window 39 * @return Metrics or else null if the window wasn't met 40 */ 41 String getMetricsWindow(int minMsecsWindow); 42 }