Package net.officefloor.server.stream.impl

Class AbstractStreamBufferPool<B>

java.lang.Object

net.officefloor.server.stream.impl.AbstractStreamBufferPool<B>

All Implemented Interfaces:

AutoCloseable, StreamBufferPool<B>

Direct Known Subclasses:

ThreadLocalStreamBufferPool

public abstract class AbstractStreamBufferPool<B>
extends Object
implements StreamBufferPool<B>

Abstract StreamBufferPool.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractStreamBufferPool.FileStreamBuffer	FileChannel StreamBuffer.
protected class	AbstractStreamBufferPool.UnpooledStreamBuffer	Unpooled StreamBuffer.

Constructor Summary

Constructors

Constructor	Description
AbstractStreamBufferPool()

Method Summary

Modifier and Type	Method	Description
StreamBuffer<B>	getFileStreamBuffer(FileChannel file, long position, long count, FileCompleteCallback callback)	Obtains a StreamBuffer for the FileChannel content.
StreamBuffer<B>	getUnpooledStreamBuffer(ByteBuffer buffer)	Obtains an StreamBuffer that is not pooled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.server.stream.StreamBufferPool

close, getPooledStreamBuffer

Constructor Details

AbstractStreamBufferPool

public AbstractStreamBufferPool()

Method Details

getUnpooledStreamBuffer

public StreamBuffer<B> getUnpooledStreamBuffer(ByteBuffer buffer)

Description copied from interface: StreamBufferPool

Obtains an StreamBuffer that is not pooled. This is for ByteBuffer instances that are managed outside the BufferPool.

Typical use is to create StreamBuffer for some read-only cached content within a ByteBuffer.

Specified by:

getUnpooledStreamBuffer in interface StreamBufferPool<B>

Parameters:

buffer - ByteBuffer.

Returns:

StreamBuffer for the unpooled ByteBuffer.

getFileStreamBuffer

public StreamBuffer<B> getFileStreamBuffer(FileChannel file,
 long position,
 long count,
 FileCompleteCallback callback)

Description copied from interface: StreamBufferPool

Obtains a StreamBuffer for the FileChannel content.

This enables efficient writing (ie DMA) of FileChannel content.

To write the entire FileChannel contents, invoke write(file, 0, -1).

Note that the underlying implementation will need to support FileChannel efficiencies.

Specified by:

getFileStreamBuffer in interface StreamBufferPool<B>

Parameters:

file - FileChannel.

position - Position within the FileChannel to start writing content. Must be non-negative number.

count - Count of bytes to write from the FileChannel. A negative value (typically -1) indicates to write the remaining FileChannel content from the position.

callback - Optional FileCompleteCallback. May be null.

Returns:

StreamBuffer for the FileChannel.