org.apache.flink.runtime.io.network.buffer.BufferProvider 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.buffer;
import org.apache.flink.runtime.io.AvailabilityProvider;
import java.io.IOException;
/**
* A buffer provider to request buffers from in a synchronous or asynchronous fashion.
*
* The data producing side (result partition writers) request buffers in a synchronous fashion,
* whereas the input side requests asynchronously.
*/
public interface BufferProvider extends AvailabilityProvider {
/**
* Returns a {@link Buffer} instance from the buffer provider, if one is available.
*
*
Returns null if no buffer is available or the buffer provider has been destroyed.
*/
Buffer requestBuffer() throws IOException;
/**
* Returns a {@link BufferBuilder} instance from the buffer provider.
*
*
If there is no buffer available, the call will block until one becomes available again or the
* buffer provider has been destroyed.
*/
BufferBuilder requestBufferBuilderBlocking() throws IOException, InterruptedException;
/**
* Adds a buffer availability listener to the buffer provider.
*
*
The operation fails with return value false, when there is a buffer available or
* the buffer provider has been destroyed.
*/
boolean addBufferListener(BufferListener listener);
/**
* Returns whether the buffer provider has been destroyed.
*/
boolean isDestroyed();
}