Module org.eclipse.jetty.io

Package org.eclipse.jetty.io

Class ArrayByteBufferPool

java.lang.Object

org.eclipse.jetty.io.ArrayByteBufferPool

All Implemented Interfaces:

ByteBufferPool

@ManagedObject
public class ArrayByteBufferPool
extends Object

A ByteBuffer pool where ByteBuffers are held in queues that are held in array elements.

Given a capacity factor of 1024, the first array element holds a queue of ByteBuffers each of capacity 1024, the second array element holds a queue of ByteBuffers each of capacity 2048, and so on.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.ByteBufferPool

ByteBufferPool.Bucket, ByteBufferPool.Lease

Constructor Summary

Constructors

Constructor	Description
ArrayByteBufferPool()	Creates a new ArrayByteBufferPool with a default configuration.
ArrayByteBufferPool(int minCapacity, int factor, int maxCapacity)	Creates a new ArrayByteBufferPool with the given configuration.
ArrayByteBufferPool(int minCapacity, int factor, int maxCapacity, int maxQueueLength)	Creates a new ArrayByteBufferPool with the given configuration.
ArrayByteBufferPool(int minCapacity, int factor, int maxCapacity, int maxQueueLength, long maxHeapMemory, long maxDirectMemory)	Creates a new ArrayByteBufferPool with the given configuration.

Method Summary

Modifier and Type	Method	Description
ByteBuffer	acquire(int size, boolean direct)	Requests a ByteBuffer of the given size.
void	clear()
protected void	decrementMemory(ByteBuffer buffer)
protected int	getCapacityFactor()
long	getDirectByteBufferCount()
long	getDirectMemory()
long	getHeapByteBufferCount()
long	getHeapMemory()
protected int	getMaxQueueLength()
long	getMemory(boolean direct)
protected void	incrementMemory(ByteBuffer buffer)
void	release(ByteBuffer buffer)	Returns a ByteBuffer, usually obtained with ByteBufferPool.acquire(int, boolean) (but not necessarily), making it available for recycling and reuse.
protected void	releaseExcessMemory(boolean direct, Consumer<Boolean> clearFn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.io.ByteBufferPool

newByteBuffer, remove

Constructor Details

ArrayByteBufferPool

public ArrayByteBufferPool()

Creates a new ArrayByteBufferPool with a default configuration.

ArrayByteBufferPool

public ArrayByteBufferPool(int minCapacity,
 int factor,
 int maxCapacity)

Creates a new ArrayByteBufferPool with the given configuration.

Parameters:

minCapacity - the minimum ByteBuffer capacity

factor - the capacity factor

maxCapacity - the maximum ByteBuffer capacity

ArrayByteBufferPool

public ArrayByteBufferPool(int minCapacity,
 int factor,
 int maxCapacity,
 int maxQueueLength)

Creates a new ArrayByteBufferPool with the given configuration.

Parameters:

minCapacity - the minimum ByteBuffer capacity

factor - the capacity factor

maxCapacity - the maximum ByteBuffer capacity

maxQueueLength - the maximum ByteBuffer queue length

ArrayByteBufferPool

public ArrayByteBufferPool(int minCapacity,
 int factor,
 int maxCapacity,
 int maxQueueLength,
 long maxHeapMemory,
 long maxDirectMemory)

Creates a new ArrayByteBufferPool with the given configuration.

Parameters:

minCapacity - the minimum ByteBuffer capacity

factor - the capacity factor

maxCapacity - the maximum ByteBuffer capacity

maxQueueLength - the maximum ByteBuffer queue length

maxHeapMemory - the max heap memory in bytes

maxDirectMemory - the max direct memory in bytes

Method Details

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.

Parameters:

size - the size of the buffer

direct - whether the buffer must be direct or not

Returns:

the requested buffer

See Also:

• ByteBufferPool.release(ByteBuffer)

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.

Parameters:

buffer - the buffer to return

See Also:

• ByteBufferPool.acquire(int, boolean)

clear

public void clear()

getDirectByteBufferCount

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

getHeapByteBufferCount

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

getCapacityFactor

protected int getCapacityFactor()

getMaxQueueLength

protected int getMaxQueueLength()

decrementMemory

protected void decrementMemory(ByteBuffer buffer)

incrementMemory

protected void incrementMemory(ByteBuffer buffer)

releaseExcessMemory

protected void releaseExcessMemory(boolean direct,
 Consumer<Boolean> clearFn)

getDirectMemory

@ManagedAttribute("The bytes retained by direct ByteBuffers")
public long getDirectMemory()

getHeapMemory

@ManagedAttribute("The bytes retained by heap ByteBuffers")
public long getHeapMemory()

getMemory

public long getMemory(boolean direct)