de.jungblut.datastructure

Class AsyncBufferedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

de.jungblut.datastructure.AsyncBufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class AsyncBufferedOutputStream
extends FilterOutputStream

BufferedOutputStream that asynchronously flushes to disk, so callers don't have to wait until the flush happens. Buffers are put into a queue that is written asynchronously to disk once it is really available. This class is thread-safe. The error handling (as all stream ops are done asynchronously) is done during write and close. Exceptions on the asynchronous thread will be thrown to the caller either while writing or closing this stream.

Author:

thomas.jungblut

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
AsyncBufferedOutputStream(OutputStream out) Creates an asynchronous buffered output stream with 8K buffer and 5 maximal buffers.
AsyncBufferedOutputStream(OutputStream out, int bufSize) Creates an asynchronous buffered output stream with defined buffersize and 5 maximal buffers.
AsyncBufferedOutputStream(OutputStream out, int bufSize, int maxBuffers) Creates an asynchronous buffered output stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes this buffered output stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this buffered output stream.
void	write(int b) Writes the specified byte to this buffered output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncBufferedOutputStream

public AsyncBufferedOutputStream(OutputStream out)

Creates an asynchronous buffered output stream with 8K buffer and 5 maximal buffers.

AsyncBufferedOutputStream

public AsyncBufferedOutputStream(OutputStream out,
                                 int bufSize)

Creates an asynchronous buffered output stream with defined buffersize and 5 maximal buffers.

AsyncBufferedOutputStream

public AsyncBufferedOutputStream(OutputStream out,
                                 int bufSize,
                                 int maxBuffers)

Creates an asynchronous buffered output stream.

Parameters:

out - the outputstream to layer on.

bufSize - the buffer size.

maxBuffers - the number of buffers to keep in parallel.

Method Detail

write

public void write(int b)
           throws IOException

Writes the specified byte to this buffered output stream.

Overrides:

write in class FilterOutputStream

Parameters:

b - the byte to be written.

Throws:

IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Writes len bytes from the specified byte array starting at offset off to this buffered output stream.

Overrides:

write in class FilterOutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

IOException - if an I/O error occurs.

flush

public void flush()
           throws IOException

Flushes this buffered output stream. It will enforce that the current buffer will be queue for asynchronous flushing no matter what size it has.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException