network/client/StreamCallback.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.client;
0019
0020 import java.io.IOException;
0021 import java.nio.ByteBuffer;
0022
0023 /**
0024  * Callback for streaming data. Stream data will be offered to the
0025  * {@link #onData(String, ByteBuffer)} method as it arrives. Once all the stream data is received,
0026  * {@link #onComplete(String)} will be called.
0027  * <p>
0028  * The network library guarantees that a single thread will call these methods at a time, but
0029  * different call may be made by different threads.
0030  */
0031 public interface StreamCallback {
0032   /** Called upon receipt of stream data. */
0033   void onData(String streamId, ByteBuffer buf) throws IOException;
0034
0035   /** Called when all data from the stream has been received. */
0036   void onComplete(String streamId) throws IOException;
0037
0038   /** Called if there's an error reading data from the stream. */
0039   void onFailure(String streamId, Throwable cause) throws IOException;
0040 }