Package net.officefloor.server.stream.impl

Class ThreadLocalStreamBufferPool

java.lang.Object

net.officefloor.server.stream.impl.AbstractStreamBufferPool<java.nio.ByteBuffer>

net.officefloor.server.stream.impl.ThreadLocalStreamBufferPool

All Implemented Interfaces:

java.lang.AutoCloseable, ThreadCompletionListener, ThreadCompletionListenerFactory, StreamBufferPool<java.nio.ByteBuffer>

public class ThreadLocalStreamBufferPool
extends AbstractStreamBufferPool<java.nio.ByteBuffer>
implements ThreadCompletionListenerFactory, ThreadCompletionListener

StreamBufferPool of ByteBuffer instances that utilises ThreadLocal caches for performance.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.server.stream.impl.AbstractStreamBufferPool

AbstractStreamBufferPool.FileStreamBuffer, AbstractStreamBufferPool.UnpooledStreamBuffer

Constructor Summary

Constructors

Constructor	Description
ThreadLocalStreamBufferPool(ByteBufferFactory byteBufferFactory, int maxThreadLocalPoolSize, int maxCorePoolSize)	Instantiate with details of pool sizes.

Method Summary

Modifier and Type	Method	Description
void	activeThreadLocalPooling()	Activates ThreadLocal pooling of StreamBuffer on current Thread.
void	close()	Closes pool releasing all StreamBuffer instances.
ThreadCompletionListener	createThreadCompletionListener(ManagedObjectPool pool)	============= ThreadCompletionListenerFactory =========
StreamBuffer<java.nio.ByteBuffer>	getPooledStreamBuffer()	=============== StreamBufferPool ===========================
int	getStreamBufferCount()	Obtains the number of StreamBuffer instances in circulation.
void	threadComplete()	================= ThreadCompletionListener ============

Methods inherited from class net.officefloor.server.stream.impl.AbstractStreamBufferPool

getFileStreamBuffer, getUnpooledStreamBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalStreamBufferPool

public ThreadLocalStreamBufferPool(ByteBufferFactory byteBufferFactory,
                                   int maxThreadLocalPoolSize,
                                   int maxCorePoolSize)

Instantiate with details of pool sizes.

The total potential amount of memory used is:

pooledByteBufferSize * (active buffers + (threadLocalPoolSize * active threads) + corePoolSize).

Parameters:

byteBufferFactory - ByteBufferFactory.

maxThreadLocalPoolSize - Maximum ThreadLocal pool size.

maxCorePoolSize - Maximum core pool size.

Method Detail

activeThreadLocalPooling

public void activeThreadLocalPooling()

Activates ThreadLocal pooling of StreamBuffer on current Thread.

getStreamBufferCount

public int getStreamBufferCount()

Obtains the number of StreamBuffer instances in circulation.

Returns:

Number of StreamBuffer instances in circulation.

getPooledStreamBuffer

public StreamBuffer<java.nio.ByteBuffer> getPooledStreamBuffer()

=============== StreamBufferPool ===========================

Specified by:

getPooledStreamBuffer in interface StreamBufferPool<java.nio.ByteBuffer>

Returns:

StreamBuffer.

close

public void close()

Description copied from interface: StreamBufferPool

Closes pool releasing all StreamBuffer instances.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface StreamBufferPool<java.nio.ByteBuffer>

createThreadCompletionListener

public ThreadCompletionListener createThreadCompletionListener(ManagedObjectPool pool)

============= ThreadCompletionListenerFactory =========

Specified by:

createThreadCompletionListener in interface ThreadCompletionListenerFactory

Parameters:

pool - ManagedObjectPool.

Returns:

ThreadCompletionListener for the ManagedObjectPool.

threadComplete

public void threadComplete()

================= ThreadCompletionListener ============

Specified by:

threadComplete in interface ThreadCompletionListener