Top Description Fields Constructors Methods
org.xnio.streams

public Class ChannelOutputStream

extends OutputStream
Class Inheritance
Static Imports
org.xnio._private.Messages.msg
An output stream which writes to a stream sink channel. All write operations are directly performed upon the channel, so for optimal performance, a buffering output stream should be used to wrap this class.
Since
1.2

Field Summary

Modifier and TypeField and Description
protected final StreamSinkChannel
channel

private static final int
FLAG_CLOSED

private static final int
FLAG_ENTERED

private volatile int
flags

private static final AtomicIntegerFieldUpdater<ChannelOutputStream>
flagsUpdater

private volatile long
timeout

Constructor Summary

AccessConstructor and Description
public
ChannelOutputStream(final StreamSinkChannel
the channel to wrap
channel)

Construct a new instance.

public
ChannelOutputStream(final StreamSinkChannel
the channel to wrap
channel, final long
the write timeout
timeout, final TimeUnit
the write timeout units
unit)

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

private boolean
enter()

private void
exit(boolean setEof)

public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out.

public long

Returns:

the timeout in the given unit
getWriteTimeout(TimeUnit
the time unit
unit)

Get the write timeout.

public void
setWriteTimeout(long
the write timeout, or 0 for none
timeout, TimeUnit
the time unit
unit)

Set the write timeout.

public void
write(final int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(final byte[]
the data.
b)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.

public void
write(final byte[]
the data.
b, final int
the start offset in the data.
off, final int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

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

Inherited from java.io.OutputStream:
nullOutputStream

Field Detail

channelback to summary
protected final StreamSinkChannel channel
FLAG_CLOSEDback to summary
private static final int FLAG_CLOSED
FLAG_ENTEREDback to summary
private static final int FLAG_ENTERED
flagsback to summary
private volatile int flags
Annotations
@SuppressWarnings:unused
flagsUpdaterback to summary
private static final AtomicIntegerFieldUpdater<ChannelOutputStream> flagsUpdater
timeoutback to summary
private volatile long timeout

Constructor Detail

ChannelOutputStreamback to summary
public ChannelOutputStream(final StreamSinkChannel channel)

Construct a new instance. No write timeout is configured.

Parameters
channel:StreamSinkChannel

the channel to wrap

ChannelOutputStreamback to summary
public ChannelOutputStream(final StreamSinkChannel channel, final long timeout, final TimeUnit unit)

Construct a new instance.

Parameters
channel:StreamSinkChannel

the channel to wrap

timeout:long

the write timeout

unit:TimeUnit

the write timeout units

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions
IOException:
if an I/O error occurs.
enterback to summary
private boolean enter()
exitback to summary
private void exit(boolean setEof)
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Exceptions
IOException:
if an I/O error occurs.
getWriteTimeoutback to summary
public long getWriteTimeout(TimeUnit unit)

Get the write timeout.

Parameters
unit:TimeUnit

the time unit

Returns:long

the timeout in the given unit

setWriteTimeoutback to summary
public void setWriteTimeout(long timeout, TimeUnit unit)

Set the write timeout. Does not affect write operations in progress.

Parameters
timeout:long

the write timeout, or 0 for none

unit:TimeUnit

the time unit

writeback to summary
public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(final byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
b:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.