org.mule.runtime.core.internal.streaming.bytes

Class PoolingByteBufferManager

java.lang.Object

org.mule.runtime.core.internal.streaming.bytes.PoolingByteBufferManager

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, ByteBufferManager

public class PoolingByteBufferManager
extends Object
implements ByteBufferManager, org.mule.runtime.api.lifecycle.Disposable

ByteBufferManager implementation which pools instances for better performance.

Buffers are kept in separate pools depending on their capacity.

Idle buffers and capacity pools are automatically expired.

Unlike traditional pools which are exhausted in terms of number of instances, we don't care about the number of buffers pooled but in the amount of memory they retain. This pool will be exhausted when a certain threshold of retained memory is reached. When exhausted, invokations to allocate(int) will block until more memory becomes available (by invoking deallocate(ByteBuffer)). If allocate(int) is blocked by more than waitTimeoutMillis milliseconds, then a MaxStreamingMemoryExceededException is thrown.

Since:

4.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
PoolingByteBufferManager() Creates a new instance which allows the pool to grow up to 50% of the runtime's max memory and has a wait timeout of 10 seconds.
PoolingByteBufferManager(MemoryManager memoryManager, long waitTimeoutMillis) Creates a new instance which allows the pool to grow up to 50% of calling MemoryManager.getMaxMemory() on the given memoryManager, and has waitTimeoutMillis as wait timeout.

Method Summary

Modifier and Type	Method and Description
ByteBuffer	allocate(int capacity) Returns a ByteBuffer of the given capacity.
void	deallocate(ByteBuffer byteBuffer) Indicates that the given byteBuffer is no longer needed and the runtime may dispose of it however it sees fit.
void	dispose()

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolingByteBufferManager

public PoolingByteBufferManager()

Creates a new instance which allows the pool to grow up to 50% of the runtime's max memory and has a wait timeout of 10 seconds. The definition of max memory is that of MemoryManager.getMaxMemory()

PoolingByteBufferManager

public PoolingByteBufferManager(MemoryManager memoryManager,
                                long waitTimeoutMillis)

Creates a new instance which allows the pool to grow up to 50% of calling MemoryManager.getMaxMemory() on the given memoryManager, and has waitTimeoutMillis as wait timeout.

Parameters:

memoryManager - a MemoryManager used to determine the runtime's max memory

waitTimeoutMillis - how long to wait when the pool is exhausted

Method Detail

allocate

public ByteBuffer allocate(int capacity)

Returns a ByteBuffer of the given capacity.

Invokers MUST call the ByteBufferManager.deallocate(ByteBuffer) method with the returned buffer once it's no longer needed.

Specified by:

allocate in interface ByteBufferManager

Parameters:

capacity - the capacity of the returned buffer

Returns:

a ByteBuffer of the given capacity

deallocate

public void deallocate(ByteBuffer byteBuffer)

Indicates that the given byteBuffer is no longer needed and the runtime may dispose of it however it sees fit.

Specified by:

deallocate in interface ByteBufferManager

Parameters:

byteBuffer - the buffer to be deallocated.

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable