Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-1505] [distributed runtime] Separate reader API from result co…
…nsumption This closes #428.
- Loading branch information
Showing
52 changed files
with
1,798 additions
and
1,576 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
...-runtime/src/main/java/org/apache/flink/runtime/io/network/api/reader/AbstractReader.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Original file line | Diff line number | Diff line change |
|---|---|---|---|
| @@ -0,0 +1,146 @@ | |||
| /* | |||
| * Licensed to the Apache Software Foundation (ASF) under one | |||
| * or more contributor license agreements. See the NOTICE file | |||
| * distributed with this work for additional information | |||
| * regarding copyright ownership. The ASF licenses this file | |||
| * to you under the Apache License, Version 2.0 (the | |||
| * "License"); you may not use this file except in compliance | |||
| * with the License. You may obtain a copy of the License at | |||
| * | |||
| * http://www.apache.org/licenses/LICENSE-2.0 | |||
| * | |||
| * Unless required by applicable law or agreed to in writing, software | |||
| * distributed under the License is distributed on an "AS IS" BASIS, | |||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| * See the License for the specific language governing permissions and | |||
| * limitations under the License. | |||
| */ | |||
|
|
|||
| package org.apache.flink.runtime.io.network.api.reader; | |||
|
|
|||
| import org.apache.flink.runtime.event.task.AbstractEvent; | |||
| import org.apache.flink.runtime.event.task.TaskEvent; | |||
| import org.apache.flink.runtime.io.network.api.EndOfPartitionEvent; | |||
| import org.apache.flink.runtime.io.network.api.EndOfSuperstepEvent; | |||
| import org.apache.flink.runtime.io.network.api.TaskEventHandler; | |||
| import org.apache.flink.runtime.io.network.partition.consumer.InputGate; | |||
| import org.apache.flink.runtime.util.event.EventListener; | |||
|
|
|||
| import java.io.IOException; | |||
|
|
|||
| import static com.google.common.base.Preconditions.checkState; | |||
|
|
|||
| /** | |||
| * A basic reader implementation, which wraps an input gate and handles events. | |||
| */ | |||
| public abstract class AbstractReader implements ReaderBase { | |||
|
|
|||
| /** The input gate to read from. */ | |||
| protected final InputGate inputGate; | |||
|
|
|||
| /** The task event handler to manage task event subscriptions. */ | |||
| private final TaskEventHandler taskEventHandler = new TaskEventHandler(); | |||
|
|
|||
| /** Flag indicating whether this reader allows iteration events. */ | |||
| private boolean isIterative; | |||
|
|
|||
| /** | |||
| * The current number of end of superstep events (reset for each superstep). A superstep is | |||
| * finished after an end of superstep event has been received for each input channel. | |||
| */ | |||
| private int currentNumberOfEndOfSuperstepEvents; | |||
|
|
|||
| protected AbstractReader(InputGate inputGate) { | |||
| this.inputGate = inputGate; | |||
| } | |||
|
|
|||
| @Override | |||
| public boolean isFinished() { | |||
| return inputGate.isFinished(); | |||
| } | |||
|
|
|||
| // ------------------------------------------------------------------------ | |||
| // Events | |||
| // ------------------------------------------------------------------------ | |||
|
|
|||
| @Override | |||
| public void registerTaskEventListener(EventListener<TaskEvent> listener, Class<? extends TaskEvent> eventType) { | |||
| taskEventHandler.subscribe(listener, eventType); | |||
| } | |||
|
|
|||
| @Override | |||
| public void sendTaskEvent(TaskEvent event) throws IOException { | |||
| inputGate.sendTaskEvent(event); | |||
| } | |||
|
|
|||
| /** | |||
| * Handles the event and returns whether the reader reached an end-of-stream event (either the | |||
| * end of the whole stream or the end of an superstep). | |||
| */ | |||
| protected boolean handleEvent(AbstractEvent event) throws IOException { | |||
| final Class<?> eventType = event.getClass(); | |||
|
|
|||
| try { | |||
| // ------------------------------------------------------------ | |||
| // Runtime events | |||
| // ------------------------------------------------------------ | |||
|
|
|||
| // This event is also checked at the (single) input gate to release the respective | |||
| // channel, at which it was received. | |||
| if (eventType == EndOfPartitionEvent.class) { | |||
| return true; | |||
| } | |||
| else if (eventType == EndOfSuperstepEvent.class) { | |||
| return incrementEndOfSuperstepEventAndCheck(); | |||
| } | |||
|
|
|||
| // ------------------------------------------------------------ | |||
| // Task events (user) | |||
| // ------------------------------------------------------------ | |||
| else if (event instanceof TaskEvent) { | |||
| taskEventHandler.publish((TaskEvent) event); | |||
|
|
|||
| return false; | |||
| } | |||
| else { | |||
| throw new IllegalStateException("Received unexpected event of type " + eventType + " at reader."); | |||
| } | |||
| } | |||
| catch (Throwable t) { | |||
| throw new IOException("Error while handling event of type " + eventType + ": " + t.getMessage(), t); | |||
| } | |||
| } | |||
|
|
|||
| // ------------------------------------------------------------------------ | |||
| // Iterations | |||
| // ------------------------------------------------------------------------ | |||
|
|
|||
| @Override | |||
| public void setIterativeReader() { | |||
| isIterative = true; | |||
| } | |||
|
|
|||
| @Override | |||
| public void startNextSuperstep() { | |||
| checkState(isIterative, "Tried to start next superstep in a non-iterative reader."); | |||
| checkState(currentNumberOfEndOfSuperstepEvents == inputGate.getNumberOfInputChannels(), "Tried to start next superstep before reaching end of previous superstep."); | |||
|
|
|||
| currentNumberOfEndOfSuperstepEvents = 0; | |||
| } | |||
|
|
|||
| @Override | |||
| public boolean hasReachedEndOfSuperstep() { | |||
| if (isIterative) { | |||
| return currentNumberOfEndOfSuperstepEvents == inputGate.getNumberOfInputChannels(); | |||
| } | |||
|
|
|||
| return false; | |||
| } | |||
|
|
|||
| private boolean incrementEndOfSuperstepEventAndCheck() { | |||
| checkState(isIterative, "Tried to increment superstep count in a non-iterative reader."); | |||
| checkState(currentNumberOfEndOfSuperstepEvents + 1 <= inputGate.getNumberOfInputChannels(), "Received too many (" + currentNumberOfEndOfSuperstepEvents + ") end of superstep events."); | |||
|
|
|||
| return ++currentNumberOfEndOfSuperstepEvents == inputGate.getNumberOfInputChannels(); | |||
| } | |||
| } | |||
Oops, something went wrong.