Package com.yahoo.container.jdisc

Class ContentChannelOutputStream

java.lang.Object

java.io.OutputStream

com.yahoo.container.jdisc.ContentChannelOutputStream

All Implemented Interfaces:

com.yahoo.io.WritableByteTransmitter, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

MaxPendingContentChannelOutputStream

public class ContentChannelOutputStream
extends OutputStream
implements com.yahoo.io.WritableByteTransmitter

A buffered stream wrapping a ContentChannel.

Author:

Steinar Knutsen

Constructor Summary

Constructors

Constructor	Description
ContentChannelOutputStream(com.yahoo.jdisc.handler.ContentChannel endpoint)

Method Summary

Modifier and Type	Method	Description
void	close()	Flush the internal buffers, does not touch the ContentChannel.
void	flush()	Flush the internal buffers, does not touch the ContentChannel.
void	nonCopyingWrite(byte[] b)	Buffered write the contents of the array to this stream, transferring ownership of that array to this stream.
void	nonCopyingWrite(byte[] b, int off, int len)	Buffered write of the contents of the array to this stream, transferring ownership of that array to this stream.
void	send(ByteBuffer src)	Write a ByteBuffer to the wrapped ContentChannel.
protected void	send(ByteBuffer src, com.yahoo.jdisc.handler.CompletionHandler completionHandler)
void	write(byte[] b)	Buffered write the contents of the array to this stream, copying the contents of the given array to this stream.
void	write(byte[] b, int off, int len)	Buffered write of the contents of the array to this stream, copying the contents of the given array to this stream.
void	write(int b)	Buffered write of a single byte.
long	written()	Returns the number of bytes written to this stream

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentChannelOutputStream

public ContentChannelOutputStream(com.yahoo.jdisc.handler.ContentChannel endpoint)

Method Detail

write

public void write(int b)
           throws IOException

Buffered write of a single byte.

Specified by:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Flush the internal buffers, does not touch the ContentChannel.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Flush the internal buffers, does not touch the ContentChannel.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

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

Buffered write of the contents of the array to this stream, copying the contents of the given array to this stream. It is in other words safe to recycle the array b.

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Buffered write the contents of the array to this stream, copying the contents of the given array to this stream. It is in other words safe to recycle the array b.

Overrides:

write in class OutputStream

Throws:

IOException

nonCopyingWrite

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

Buffered write of the contents of the array to this stream, transferring ownership of that array to this stream. It is in other words not safe to recycle the array b.

Throws:

IOException

nonCopyingWrite

public void nonCopyingWrite(byte[] b)
                     throws IOException

Buffered write the contents of the array to this stream, transferring ownership of that array to this stream. It is in other words not safe to recycle the array b.

Throws:

IOException

send

public void send(ByteBuffer src)
          throws IOException

Write a ByteBuffer to the wrapped ContentChannel. Do invoke flush() before send(ByteBuffer) to avoid garbled output if the stream API has been accessed before using the ByteBuffer based API. As with ContentChannel, this transfers ownership of the ByteBuffer to this stream.

Specified by:

send in interface com.yahoo.io.WritableByteTransmitter

Throws:

IOException

send

protected void send(ByteBuffer src,
                    com.yahoo.jdisc.handler.CompletionHandler completionHandler)
             throws IOException

Throws:

IOException

written

public long written()

Returns the number of bytes written to this stream