Package org.apache.cassandra.net

Class AsyncMessageOutputPlus

java.lang.Object

java.io.OutputStream

org.apache.cassandra.io.util.DataOutputStreamPlus

org.apache.cassandra.io.util.BufferedDataOutputStreamPlus

org.apache.cassandra.net.AsyncChannelOutputPlus

org.apache.cassandra.net.AsyncMessageOutputPlus

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable, DataOutputPlus

public class AsyncMessageOutputPlus
extends AsyncChannelOutputPlus

A DataOutputStreamPlus that writes ASYNCHRONOUSLY to a Netty Channel. Intended as single use, to write one (large) message. The close() and flush() methods synchronously wait for pending writes, and will propagate any exceptions encountered in writing them to the wire. The correctness of this class depends on the ChannelPromise we create against a Channel always being completed, which appears to be a guarantee provided by Netty so long as the event loop is running.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cassandra.net.AsyncChannelOutputPlus

AsyncChannelOutputPlus.FlushException

Field Summary

Fields inherited from class org.apache.cassandra.io.util.BufferedDataOutputStreamPlus

buffer

Method Summary

Modifier and Type	Method	Description
void	close()	Flush any remaining writes, and release any buffers.
void	discard()	Discard any buffered data, and the buffers that contain it.
protected void	doFlush(int count)
long	position()	Returns the current position of the underlying target like a file-pointer or the position withing a buffer.

Methods inherited from class org.apache.cassandra.net.AsyncChannelOutputPlus

beginFlush, flush, flushed, flushedToNetwork, newDefaultChannel, parkUntilFlushed, releaseSpace

Methods inherited from class org.apache.cassandra.io.util.BufferedDataOutputStreamPlus

allocate, order, write, write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeMostSignificantBytes, writeShort, writeUTF

Methods inherited from class org.apache.cassandra.io.util.DataOutputStreamPlus

retrieveTemporaryBuffer

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

Methods inherited from interface org.apache.cassandra.io.util.DataOutputPlus

bytesLeftInPage, hasPosition, maxBytesInPage, paddedPosition, padToPageBoundary, write, writeUnsignedVInt, writeUnsignedVInt, writeUnsignedVInt32, writeVInt, writeVInt, writeVInt32

Method Details

doFlush

protected void doFlush(int count)
                throws IOException

Specified by:

doFlush in class AsyncChannelOutputPlus

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: AsyncChannelOutputPlus

Flush any remaining writes, and release any buffers. The channel is not closed, as it is assumed to be managed externally. WARNING: This method requires mutual exclusivity with all other producer methods to run safely. It should only be invoked by the owning thread, never the eventLoop; the eventLoop should propagate errors to AsyncChannelOutputPlus.flushFailed, which will propagate them to the producer thread no later than its final invocation to AsyncChannelOutputPlus.close() or AsyncChannelOutputPlus.flush() (that must not be followed by any further writes).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AsyncChannelOutputPlus

Throws:

IOException

position

public long position()

Description copied from interface: DataOutputPlus

Returns the current position of the underlying target like a file-pointer or the position withing a buffer. Not every implementation may support this functionality. Whether or not this functionality is supported can be checked via the DataOutputPlus.hasPosition().

Specified by:

position in interface DataOutputPlus

Specified by:

position in class AsyncChannelOutputPlus

discard

public void discard()

Discard any buffered data, and the buffers that contain it. May be invoked instead of close() if we terminate exceptionally.

Specified by:

discard in class AsyncChannelOutputPlus