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; 20 21 /** 22 * Interface for providing network statistics, such as bytes received etc. 23 */ 24 public interface NetworkMetrics { 25 /** 26 * Returns bytes received in current superstep 27 * @return Number of bytes. 28 */ 29 long getBytesReceivedPerSuperstep(); 30 31 /** 32 * Resets the counter for bytes received per superstep. 33 * This will be called by the component that defines 34 * when a superstep is done. 35 */ 36 void resetBytesReceivedPerSuperstep(); 37 38 /** 39 * Returns aggregate bytes received. 40 * @return Number of bytes 41 */ 42 long getBytesReceived(); 43 }