Package net.officefloor.server.stream.impl

Class BufferPoolServerOutputStream<B>

java.lang.Object

java.io.OutputStream

net.officefloor.server.stream.ServerOutputStream

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

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BufferPoolServerOutputStream<B>
extends ServerOutputStream

ServerOutputStream that writes to StreamBuffer instances from a StreamBufferPool.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
BufferPoolServerOutputStream(StreamBufferPool<B> bufferPool)	Instantiate.
BufferPoolServerOutputStream(StreamBufferPool<B> bufferPool, CloseHandler closeHandler)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this OutputStream and releases the StreamBuffer instances.
void	close()
void	flush()
StreamBuffer<B>	getBuffers()	Obtains the head StreamBuffer instances used by this ServerOutputStream.
long	getContentLength()	Obtains the content length of output data.
ServerWriter	getServerWriter(Charset charset)	Obtains the ServerWriter.
void	write(byte[] bytes, int off, int len)
void	write(int b)
void	write(ByteBuffer buffer)	Writes a ByteBuffer.
void	write(FileChannel file, long position, long count, FileCompleteCallback callback)	Writes part of the FileChannel contents.
void	write(FileChannel file, FileCompleteCallback callback)	Writes the entire FileChannel contents.

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Constructor Details

BufferPoolServerOutputStream

public BufferPoolServerOutputStream(StreamBufferPool<B> bufferPool,
 CloseHandler closeHandler)

Instantiate.

Parameters:

bufferPool - StreamBufferPool.

closeHandler - CloseHandler.

BufferPoolServerOutputStream

public BufferPoolServerOutputStream(StreamBufferPool<B> bufferPool)

Instantiate.

Parameters:

bufferPool - StreamBufferPool.

Method Details

getServerWriter

public ServerWriter getServerWriter(Charset charset)
                             throws IOException

Obtains the ServerWriter.

Parameters:

charset - Charset for writing out String data.

Returns:

ServerWriter.

Throws:

IOException - Should ServerOutputStream be closed.

getContentLength

public long getContentLength()

Obtains the content length of output data.

Returns:

Content length of output data.

getBuffers

public StreamBuffer<B> getBuffers()

Obtains the head StreamBuffer instances used by this ServerOutputStream.

Returns:

StreamBuffer instances used by this ServerOutputStream.

clear

public void clear()
           throws IOException

Clears this OutputStream and releases the StreamBuffer instances.

Throws:

IOException - If failure in clearing OutputStream.

write

public void write(ByteBuffer buffer)
           throws IOException

Description copied from class: ServerOutputStream

Writes a ByteBuffer.

This is to enable efficient I/O of writing content (typically cached).

Specified by:

write in class ServerOutputStream

Parameters:

buffer - ByteBuffer that should never change its content.

Throws:

IOException - If fails to write the ByteBuffer.

write

public void write(FileChannel file,
 long position,
 long count,
 FileCompleteCallback callback)
           throws IOException

Description copied from class: ServerOutputStream

Writes part of the FileChannel contents.

This is to enable efficient I/O (ie DMA) of writing 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:

write in class ServerOutputStream

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 position.

callback - Optional FileCompleteCallback. May be null.

Throws:

IOException - If fails to write the FileChannel content.

write

public void write(FileChannel file,
 FileCompleteCallback callback)
           throws IOException

Description copied from class: ServerOutputStream

Writes the entire FileChannel contents.

This is a convenience method for write(file, 0, -1).

Specified by:

write in class ServerOutputStream

Parameters:

file - FileChannel.

callback - Optional FileCompleteCallback. May be null.

Throws:

IOException - If fails to write the FileChannel content.

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
 int off,
 int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException