Class MappedByteBufferPool

java.lang.Object
org.eclipse.jetty.io.AbstractByteBufferPool
org.eclipse.jetty.io.MappedByteBufferPool
All Implemented Interfaces:
ByteBufferPool, Dumpable
Direct Known Subclasses:
MappedByteBufferPool.Tagged
@ManagedObject public class MappedByteBufferPool extends AbstractByteBufferPool implements Dumpable

A ByteBuffer pool where ByteBuffers are held in queues that are held in a Map.

Given a capacity factor of 1024, the Map entry with key 1 holds a queue of ByteBuffers each of capacity 1024, the Map entry with key 2 holds a queue of ByteBuffers each of capacity 2048, and so on.

  • Field Details

  • Constructor Details

    • MappedByteBufferPool

      public MappedByteBufferPool()
      Creates a new MappedByteBufferPool with a default configuration.

    • MappedByteBufferPool

      public MappedByteBufferPool(int factor)
      Creates a new MappedByteBufferPool with the given capacity factor.
      Parameters:
      factor - the capacity factor

    • MappedByteBufferPool

      public MappedByteBufferPool(int factor, int maxQueueLength)
      Creates a new MappedByteBufferPool with the given configuration.
      Parameters:
      factor - the capacity factor
      maxQueueLength - the maximum ByteBuffer queue length

    • MappedByteBufferPool

      public MappedByteBufferPool(int factor, int maxQueueLength, Function<Integer, ByteBufferPool.Bucket> newBucket)
      Creates a new MappedByteBufferPool with the given configuration.
      Parameters:
      factor - the capacity factor
      maxQueueLength - the maximum ByteBuffer queue length
      newBucket - the function that creates a Bucket

    • MappedByteBufferPool

      public MappedByteBufferPool(int factor, int maxQueueLength, Function<Integer, ByteBufferPool.Bucket> newBucket, long maxHeapMemory, long maxDirectMemory)
      Creates a new MappedByteBufferPool with the given configuration.
      Parameters:
      factor - the capacity factor
      maxQueueLength - the maximum ByteBuffer queue length
      newBucket - the function that creates a Bucket
      maxHeapMemory - the max heap memory in bytes, -1 for unlimited memory or 0 to use default heuristic.
      maxDirectMemory - the max direct memory in bytes, -1 for unlimited memory or 0 to use default heuristic.

  • Method Details

    • newBucket

      private ByteBufferPool.Bucket newBucket(int key, boolean direct)

    • acquire

      public ByteBuffer acquire(int size, boolean direct)
      Description copied from interface: ByteBufferPool

      Requests a ByteBuffer of the given size.

      The returned buffer may have a bigger capacity than the size being requested but it will have the limit set to the given size.

      Specified by:
      acquire in interface ByteBufferPool
      Parameters:
      size - the size of the buffer
      direct - whether the buffer must be direct or not
      Returns:
      the requested buffer
      See Also:

    • release

      public void release(ByteBuffer buffer)
      Description copied from interface: ByteBufferPool

      Returns a ByteBuffer, usually obtained with ByteBufferPool.acquire(int, boolean) (but not necessarily), making it available for recycling and reuse.

      Specified by:
      release in interface ByteBufferPool
      Parameters:
      buffer - the buffer to return
      See Also:

    • clear

      public void clear()
      Overrides:
      clear in class AbstractByteBufferPool

    • releaseMemory

      protected void releaseMemory(boolean direct)

    • bucketFor

      protected int bucketFor(int capacity)

    • capacityFor

      protected int capacityFor(int bucket)

    • getDirectByteBufferCount

      @ManagedAttribute("The number of pooled direct ByteBuffers") public long getDirectByteBufferCount()

    • getHeapByteBufferCount

      @ManagedAttribute("The number of pooled heap ByteBuffers") public long getHeapByteBufferCount()

    • getByteBufferCount

      private long getByteBufferCount(boolean direct)

    • bucketsFor

      ConcurrentMap<Integer, ByteBufferPool.Bucket> bucketsFor(boolean direct)

    • isDetailedDump

      public boolean isDetailedDump()

    • setDetailedDump

      public void setDetailedDump(boolean detailedDump)

    • dump

      public void dump(Appendable out, String indent) throws IOException
      Description copied from interface: Dumpable
      Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.
      Specified by:
      dump in interface Dumpable
      Parameters:
      out - The appendable to dump to
      indent - The indent to apply after any new lines.
      Throws:
      IOException - if unable to write to Appendable

    • toString

      public String toString()
      Overrides:
      toString in class Object