UpwardProtocol.java
上传用户:quxuerui
上传日期:2018-01-08
资源大小:41811k
文件大小:3k
源码类别:

网格计算

开发平台:

Java

  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. package org.apache.hadoop.mapred.pipes;
  19. import java.io.IOException;
  20. import org.apache.hadoop.io.Writable;
  21. import org.apache.hadoop.io.WritableComparable;
  22. /**
  23.  * The interface for the messages that can come up from the child. All of these
  24.  * calls are asynchronous and return before the message has been processed.
  25.  */
  26. interface UpwardProtocol<K extends WritableComparable, V extends Writable> {
  27.   /**
  28.    * Output a record from the child.
  29.    * @param key the record's key
  30.    * @param value the record's value
  31.    * @throws IOException
  32.    */
  33.   void output(K key, V value) throws IOException;
  34.   
  35.   /**
  36.    * Map functions where the application has defined a partition function
  37.    * output records along with their partition.
  38.    * @param reduce the reduce to send this record to
  39.    * @param key the record's key
  40.    * @param value the record's value
  41.    * @throws IOException
  42.    */
  43.   void partitionedOutput(int reduce, K key, 
  44.                          V value) throws IOException;
  45.   
  46.   /**
  47.    * Update the task's status message
  48.    * @param msg the string to display to the user
  49.    * @throws IOException
  50.    */
  51.   void status(String msg) throws IOException;
  52.   
  53.   /**
  54.    * Report making progress (and the current progress)
  55.    * @param progress the current progress (0.0 to 1.0)
  56.    * @throws IOException
  57.    */
  58.   void progress(float progress) throws IOException;
  59.   
  60.   /**
  61.    * Report that the application has finished processing all inputs 
  62.    * successfully.
  63.    * @throws IOException
  64.    */
  65.   void done() throws IOException;
  66.   
  67.   /**
  68.    * Report that the application or more likely communication failed.
  69.    * @param e
  70.    */
  71.   void failed(Throwable e);
  72.   
  73.   /**
  74.    * Register a counter with the given id and group/name.
  75.    * @param group counter group
  76.    * @param name counter name
  77.    * @throws IOException
  78.    */
  79.   void registerCounter(int id, String group, String name) throws IOException;
  80.   
  81.   /**
  82.    * Increment the value of a registered counter.
  83.    * @param id counter id of the registered counter
  84.    * @param amount increment for the counter value
  85.    * @throws IOException
  86.    */
  87.   void incrementCounter(int id, long amount) throws IOException;
  88. }