[Distributed runtime] Rename read method of BufferReader to indicate …

…blocking behaviour
apache · Jan 19, 2015 · c9709a8 · c9709a8
1 parent d1cc30d
commit c9709a8
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/...me/src/main/java/org/apache/flink/runtime/io/network/api/reader/AbstractRecordReader.java b/...me/src/main/java/org/apache/flink/runtime/io/network/api/reader/AbstractRecordReader.java
@@ -75,7 +75,7 @@ protected boolean getNextRecord(T target) throws IOException, InterruptedExcepti
 				}
 			}
 
-			final Buffer nextBuffer = reader.getNextBuffer();
+			final Buffer nextBuffer = reader.getNextBufferBlocking();
 			final int channelIndex = reader.getChannelIndexOfLastBuffer();
 
 			if (nextBuffer == null) {

diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/api/reader/BufferReader.java b/flink-runtime/src/main/java/org/apache/flink/runtime/io/network/api/reader/BufferReader.java
@@ -230,7 +230,7 @@ public void requestPartitionsOnce() throws IOException {
 	}
 
 	@Override
-	public Buffer getNextBuffer() throws IOException, InterruptedException {
+	public Buffer getNextBufferBlocking() throws IOException, InterruptedException {
 		requestPartitionsOnce();
 
 		while (true) {

diff --git a/...untime/src/main/java/org/apache/flink/runtime/io/network/api/reader/BufferReaderBase.java b/...untime/src/main/java/org/apache/flink/runtime/io/network/api/reader/BufferReaderBase.java
@@ -30,9 +30,9 @@
  * <p>
  * {@link BufferReaderBase} is the runtime API for consuming results. Events
  * are handled by the reader and users can query for buffers with
- * {@link #getNextBuffer()} or {@link #getNextBuffer(Buffer)}.
+ * {@link #getNextBufferBlocking()} or {@link #getNextBuffer(Buffer)}.
  * <p>
- * <strong>Important</strong>: If {@link #getNextBuffer()} is used, it is
+ * <strong>Important</strong>: If {@link #getNextBufferBlocking()} is used, it is
  * necessary to release the returned buffers with {@link Buffer#recycle()}
  * after they are consumed.
  */
@@ -50,10 +50,10 @@ public interface BufferReaderBase extends ReaderBase {
 	 *
 	 * @see #getChannelIndexOfLastBuffer()
 	 */
-	Buffer getNextBuffer() throws IOException, InterruptedException;
+	Buffer getNextBufferBlocking() throws IOException, InterruptedException;
 
 	/**
-	 * {@link #getNextBuffer()} requires the user to quickly recycle the
+	 * {@link #getNextBufferBlocking()} requires the user to quickly recycle the
 	 * returned buffer. For a fully buffer-oriented runtime, we need to
 	 * support a variant of this method, which allows buffers to be exchanged
 	 * in order to save unnecessary memory copies between buffer pools.
@@ -66,7 +66,7 @@ public interface BufferReaderBase extends ReaderBase {
 
 	/**
 	 * Returns a channel index for the last {@link Buffer} instance returned by
-	 * {@link #getNextBuffer()} or {@link #getNextBuffer(Buffer)}.
+	 * {@link #getNextBufferBlocking()} or {@link #getNextBuffer(Buffer)}.
 	 * <p>
 	 * The returned index is guaranteed to be the same for all buffers read by
 	 * the same {@link RemoteInputChannel} instance. This is useful when data spans

diff --git a/...ntime/src/main/java/org/apache/flink/runtime/io/network/api/reader/UnionBufferReader.java b/...ntime/src/main/java/org/apache/flink/runtime/io/network/api/reader/UnionBufferReader.java
@@ -101,7 +101,7 @@ public void requestPartitionsOnce() throws IOException {
 
 
 	@Override
-	public Buffer getNextBuffer() throws IOException, InterruptedException {
+	public Buffer getNextBufferBlocking() throws IOException, InterruptedException {
 		requestPartitionsOnce();
 
 		do {
@@ -135,7 +135,7 @@ else if (isIterative && remainingReaders.isEmpty()) {
 				}
 			}
 
-			Buffer buffer = currentReader.getNextBuffer();
+			Buffer buffer = currentReader.getNextBufferBlocking();
 			channelIndexOfLastReadBuffer = currentReaderChannelIndexOffset + currentReader.getChannelIndexOfLastBuffer();
 
 			isTaskEvent = false;

diff --git a/...untime/src/test/java/org/apache/flink/runtime/io/network/api/reader/BufferReaderTest.java b/...untime/src/test/java/org/apache/flink/runtime/io/network/api/reader/BufferReaderTest.java
@@ -109,7 +109,7 @@ public void testExceptionEndOfSuperstepEventWithNonIterativeReader() throws IOEx
 		final BufferReader reader = mockReader.getMock();
 
 		// Should throw Exception, because it's a non-iterative reader
-		reader.getNextBuffer();
+		reader.getNextBufferBlocking();
 	}
 
 	// ------------------------------------------------------------------------
@@ -128,7 +128,7 @@ static void consumeAndVerify(BufferReaderBase reader, int expectedNumReadBuffers
 
 		while (true) {
 			Buffer buffer;
-			while ((buffer = reader.getNextBuffer()) != null) {
+			while ((buffer = reader.getNextBufferBlocking()) != null) {
 				buffer.recycle();
 
 				numReadBuffers++;