Package net.officefloor.server.http.vertx

Class VertxBufferPool

java.lang.Object

net.officefloor.server.stream.StreamBuffer<io.vertx.core.buffer.Buffer>

net.officefloor.server.http.vertx.VertxBufferPool

All Implemented Interfaces:

AutoCloseable, StreamBufferPool<io.vertx.core.buffer.Buffer>

public class VertxBufferPool
extends StreamBuffer<io.vertx.core.buffer.Buffer>
implements StreamBufferPool<io.vertx.core.buffer.Buffer>

Vertx StreamBufferPool.

Author:

Daniel Sagenschneider

Nested Class Summary

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

StreamBuffer.FileBuffer

Field Summary

Fields inherited from class net.officefloor.server.stream.StreamBuffer

fileBuffer, next, pooledBuffer, unpooledByteBuffer

Constructor Summary

Constructors

Constructor	Description
VertxBufferPool()	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes pool releasing all StreamBuffer instances.
StreamBuffer<io.vertx.core.buffer.Buffer>	getFileStreamBuffer(FileChannel file, long position, long count, FileCompleteCallback callback)	Obtains a StreamBuffer for the FileChannel content.
StreamBuffer<io.vertx.core.buffer.Buffer>	getPooledStreamBuffer()	Obtains a StreamBuffer.
StreamBuffer<io.vertx.core.buffer.Buffer>	getUnpooledStreamBuffer(ByteBuffer buffer)	Obtains an StreamBuffer that is not pooled.
void	release()	Releases this StreamBuffer for re-use.
boolean	write(byte datum)	Writes a byte to the pooled buffer.
int	write(byte[] data, int offset, int length)	Writes the data to the pooled buffer.

Methods inherited from class net.officefloor.server.stream.StreamBuffer

getAppendable, getWriteStreamBuffer, write, write, write, write, write, write, writeByte

Methods inherited from class java.lang.Object

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

Constructor Details

VertxBufferPool

public VertxBufferPool()

Instantiate.

Method Details

getPooledStreamBuffer

public StreamBuffer<io.vertx.core.buffer.Buffer> getPooledStreamBuffer()

Description copied from interface: StreamBufferPool

Obtains a StreamBuffer.

Specified by:

getPooledStreamBuffer in interface StreamBufferPool<io.vertx.core.buffer.Buffer>

Returns:

StreamBuffer.

getUnpooledStreamBuffer

public StreamBuffer<io.vertx.core.buffer.Buffer> 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<io.vertx.core.buffer.Buffer>

Parameters:

buffer - ByteBuffer.

Returns:

StreamBuffer for the unpooled ByteBuffer.

getFileStreamBuffer

public StreamBuffer<io.vertx.core.buffer.Buffer> getFileStreamBuffer(FileChannel file,
 long position,
 long count,
 FileCompleteCallback callback)
                                                              throws IOException

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<io.vertx.core.buffer.Buffer>

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.

Throws:

IOException - If fails to create the StreamBuffer for the FileChannel. Typically, this is because the underlying implementation does not support DMA and copies the data from the FileChannel.

close

public void close()

Description copied from interface: StreamBufferPool

Closes pool releasing all StreamBuffer instances.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface StreamBufferPool<io.vertx.core.buffer.Buffer>

write

public boolean write(byte datum)

Description copied from class: StreamBuffer

Writes a byte to the pooled buffer.

Specified by:

write in class StreamBuffer<io.vertx.core.buffer.Buffer>

Parameters:

datum - Byte value.

Returns:

true if written value to buffer. false indicates the pooled buffer is full.

write

public int write(byte[] data,
 int offset,
 int length)

Description copied from class: StreamBuffer

Writes the data to the pooled buffer.

Specified by:

write in class StreamBuffer<io.vertx.core.buffer.Buffer>

Parameters:

data - Data to write to the pooled buffer.

offset - Offset within the data to write the data.

length - Length of data to write the data.

Returns:

Number of bytes written.

release

public void release()

Description copied from class: StreamBuffer

Releases this StreamBuffer for re-use.

Specified by:

release in class StreamBuffer<io.vertx.core.buffer.Buffer>