org.apache.flink.runtime.io.network.buffer.BufferPoolFactory 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 java.io.IOException;
/**
* A factory for buffer pools.
*/
public interface BufferPoolFactory {
/**
* Tries to create a buffer pool, which is guaranteed to provide at least the number of required
* buffers.
*
* The buffer pool is of dynamic size with at least numRequiredBuffers buffers.
*
* @param numRequiredBuffers
* minimum number of network buffers in this pool
* @param maxUsedBuffers
* maximum number of network buffers this pool offers
*/
BufferPool createBufferPool(int numRequiredBuffers, int maxUsedBuffers) throws IOException;
/**
* Tries to create a buffer pool with an owner, which is guaranteed to provide at least the
* number of required buffers.
*
*
The buffer pool is of dynamic size with at least numRequiredBuffers buffers.
*
* @param numRequiredBuffers
* minimum number of network buffers in this pool
* @param maxUsedBuffers
* maximum number of network buffers this pool offers
* @param bufferPoolOwner
* the owner of this buffer pool to release memory when needed
*/
BufferPool createBufferPool(int numRequiredBuffers, int maxUsedBuffers, BufferPoolOwner bufferPoolOwner) throws IOException;
/**
* Destroy callback for updating factory book keeping.
*/
void destroyBufferPool(BufferPool bufferPool) throws IOException;
}