Package org.apache.flink.runtime.io.network.buffer

Interface BufferPoolFactory

  • All Known Implementing Classes:
    NetworkBufferPool
    public interface BufferPoolFactory
    A factory for buffer pools.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      BufferPool createBufferPool​(int numRequiredBuffers, int maxUsedBuffers)
      Tries to create a buffer pool, which is guaranteed to provide at least the number of required buffers.
      BufferPool createBufferPool​(int numRequiredBuffers, int maxUsedBuffers, int numSubpartitions, int maxBuffersPerChannel, int maxOverdraftBuffersPerGate)
      Tries to create a buffer pool with an owner, which is guaranteed to provide at least the number of required buffers.
      void destroyBufferPool​(BufferPool bufferPool)
      Destroy callback for updating factory book keeping.

    • Method Detail

      • createBufferPool

        BufferPool createBufferPool​(int numRequiredBuffers,
                            int maxUsedBuffers)
                     throws IOException
        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.

        Parameters:
        numRequiredBuffers - minimum number of network buffers in this pool
        maxUsedBuffers - maximum number of network buffers this pool offers
        Throws:
        IOException

      • createBufferPool

        BufferPool createBufferPool​(int numRequiredBuffers,
                            int maxUsedBuffers,
                            int numSubpartitions,
                            int maxBuffersPerChannel,
                            int maxOverdraftBuffersPerGate)
                     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.

        Parameters:
        numRequiredBuffers - minimum number of network buffers in this pool
        maxUsedBuffers - maximum number of network buffers this pool offers
        numSubpartitions - number of subpartitions in this pool
        maxBuffersPerChannel - maximum number of buffers to use for each channel
        maxOverdraftBuffersPerGate - maximum number of overdraft buffers to use for each gate
        Throws:
        IOException

      • destroyBufferPool

        void destroyBufferPool​(BufferPool bufferPool)
                throws IOException
        Destroy callback for updating factory book keeping.
        Throws:
        IOException