network/shuffle/BlockFetchingListener.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.network.shuffle;
0019
0020 import java.util.EventListener;
0021
0022 import org.apache.spark.network.buffer.ManagedBuffer;
0023
0024 public interface BlockFetchingListener extends EventListener {
0025   /**
0026    * Called once per successfully fetched block. After this call returns, data will be released
0027    * automatically. If the data will be passed to another thread, the receiver should retain()
0028    * and release() the buffer on their own, or copy the data to a new buffer.
0029    */
0030   void onBlockFetchSuccess(String blockId, ManagedBuffer data);
0031
0032   /**
0033    * Called at least once per block upon failures.
0034    */
0035   void onBlockFetchFailure(String blockId, Throwable exception);
0036 }