Module

Package org.xnio.streams

Class BufferPipeOutputStream

java.lang.Object

java.io.OutputStream

org.xnio.streams.BufferPipeOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class BufferPipeOutputStream
extends java.io.OutputStream

An OutputStream implementation which writes out ByteBuffers to a consumer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BufferPipeOutputStream.BufferWriter	A buffer writer for an BufferPipeOutputStream.

Constructor Summary

Constructors

Constructor	Description
BufferPipeOutputStream(BufferPipeOutputStream.BufferWriter bufferWriterTask)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
Pooled<java.nio.ByteBuffer>	breakPipe()	Break the pipe and return any filling pooled buffer.
void	close()
void	flush()
void	write(byte[] b, int off, int len)
void	write(int b)

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 Detail

BufferPipeOutputStream

public BufferPipeOutputStream(BufferPipeOutputStream.BufferWriter bufferWriterTask)
                       throws java.io.IOException

Construct a new instance. The internal buffers will have a capacity of bufferSize. The given bufferWriterTask will be called to send buffers, flush the output stream, and handle the end-of-file condition.

Parameters:

bufferWriterTask - the writer task

Throws:

java.io.IOException - if an error occurs while initializing the stream

Method Detail

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

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

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

breakPipe

public Pooled<java.nio.ByteBuffer> breakPipe()

Break the pipe and return any filling pooled buffer. Sets the stream to an EOF condition. Callers to this method should ensure that any threads blocked on BufferPipeOutputStream.BufferWriter.accept(org.xnio.Pooled, boolean) are unblocked, preferably with a BrokenPipeException.

Returns:

the current pooled buffer, or null if none was pending