org.apache.flink.runtime.io.network.api.writer.ResultPartitionWriter Maven / Gradle / Ivy
/*
* 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.writer;
import org.apache.flink.runtime.event.AbstractEvent;
import org.apache.flink.runtime.event.TaskEvent;
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.api.serialization.EventSerializer;
import org.apache.flink.runtime.io.network.buffer.Buffer;
import org.apache.flink.runtime.io.network.buffer.BufferProvider;
import org.apache.flink.runtime.io.network.partition.ResultPartition;
import org.apache.flink.runtime.io.network.partition.ResultPartitionID;
import org.apache.flink.runtime.util.event.EventListener;
import java.io.IOException;
/**
* A buffer-oriented runtime result writer.
*
* The {@link ResultPartitionWriter} is the runtime API for producing results. It
* supports two kinds of data to be sent: buffers and events.
*/
public final class ResultPartitionWriter implements EventListener {
private final ResultPartition partition;
private final TaskEventHandler taskEventHandler = new TaskEventHandler();
public ResultPartitionWriter(ResultPartition partition) {
this.partition = partition;
}
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
public ResultPartitionID getPartitionId() {
return partition.getPartitionId();
}
public BufferProvider getBufferProvider() {
return partition.getBufferProvider();
}
public int getNumberOfOutputChannels() {
return partition.getNumberOfSubpartitions();
}
// ------------------------------------------------------------------------
// Data processing
// ------------------------------------------------------------------------
public void writeBuffer(Buffer buffer, int targetChannel) throws IOException {
partition.add(buffer, targetChannel);
}
public void writeEvent(AbstractEvent event, int targetChannel) throws IOException {
partition.add(EventSerializer.toBuffer(event), targetChannel);
}
public void writeEventToAllChannels(AbstractEvent event) throws IOException {
for (int i = 0; i < partition.getNumberOfSubpartitions(); i++) {
Buffer buffer = EventSerializer.toBuffer(event);
partition.add(buffer, i);
}
}
public void writeEndOfSuperstep() throws IOException {
for (int i = 0; i < partition.getNumberOfSubpartitions(); i++) {
Buffer buffer = EventSerializer.toBuffer(EndOfSuperstepEvent.INSTANCE);
partition.add(buffer, i);
}
}
// ------------------------------------------------------------------------
// Event handling
// ------------------------------------------------------------------------
public void subscribeToEvent(EventListener eventListener, Class eventType) {
taskEventHandler.subscribe(eventListener, eventType);
}
@Override
public void onEvent(TaskEvent event) {
taskEventHandler.publish(event);
}
}