org.jboss.remoting3

Class MessageOutputStream

java.lang.Object

java.io.OutputStream

org.jboss.remoting3.MessageOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, org.xnio.Cancellable

public abstract class MessageOutputStream
extends java.io.OutputStream
implements org.xnio.Cancellable

An output stream for a message.

Author:

David M. Lloyd

Constructor Summary

Constructors

Constructor and Description
MessageOutputStream()

Method Summary

Methods

Modifier and Type	Method and Description
abstract MessageOutputStream	cancel() Cancel this message stream.
abstract void	close() Close this message stream.
abstract void	flush() Flush this message stream.

Methods inherited from class java.io.OutputStream

write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageOutputStream

public MessageOutputStream()

Method Detail

flush

public abstract void flush()
                    throws java.io.IOException

Flush this message stream. Any unwritten, buffered bytes are sent to the remote side.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

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

close

public abstract void close()
                    throws java.io.IOException

Close this message stream. If the stream is already closed or cancelled, this method has no effect. After this method is called, any further attempts to write to the stream will result in an exception.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - if a error occurs while closing the stream

cancel

public abstract MessageOutputStream cancel()

Cancel this message stream. If the stream is already closed or cancelled, this method has no effect. After this method is called, any further attempts to write to the stream will result in an exception.

Specified by:

cancel in interface org.xnio.Cancellable

Returns:

this stream