io.undertow.conduits

Class AbstractFramedStreamSinkConduit

java.lang.Object

org.xnio.conduits.AbstractConduit<D>

org.xnio.conduits.AbstractSinkConduit<D>

org.xnio.conduits.AbstractStreamSinkConduit<StreamSinkConduit>

io.undertow.conduits.AbstractFramedStreamSinkConduit

All Implemented Interfaces:

Conduit, SinkConduit, StreamSinkConduit

public class AbstractFramedStreamSinkConduit
extends AbstractStreamSinkConduit<StreamSinkConduit>

Utility class to ease the implementation of framed protocols. This call provides a queue of frames, and a callback that can be invoked when a frame event occurs.

When a write takes place all frames are attempted to be written out at once via a gathering write. Frames can be queued via queueFrame(io.undertow.conduits.AbstractFramedStreamSinkConduit.FrameCallBack, java.nio.ByteBuffer...).

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractFramedStreamSinkConduit.FrameCallBack Interface that is called when a frame event takes place.
protected static class	AbstractFramedStreamSinkConduit.PooledBufferFrameCallback
protected static class	AbstractFramedStreamSinkConduit.PooledBuffersFrameCallback

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit

next

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFramedStreamSinkConduit(StreamSinkConduit next) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	doTerminateWrites()
protected void	finished()
protected boolean	flushQueuedData()
protected boolean	isWritesTerminated()
protected void	queueCloseFrames()
protected long	queuedDataLength()
protected void	queueFrame(AbstractFramedStreamSinkConduit.FrameCallBack callback, ByteBuffer... data) Queues a frame for sending.
void	terminateWrites() Signal that no more write data is forthcoming.
long	transferFrom(FileChannel src, long position, long count) Transfer bytes into this conduit from the given file.
long	transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) Transfers bytes from the given channel source.
void	truncateWrites() Terminate writes and discard any outstanding write data.
int	write(ByteBuffer src) Writes a sequence of bytes to this conduit from the given buffer.
long	write(ByteBuffer[] srcs, int offs, int len) Writes a sequence of bytes to this conduit from the given buffers.
int	writeFinal(ByteBuffer src) Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer).
long	writeFinal(ByteBuffer[] srcs, int offs, int len) Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer[], int, int).

Methods inherited from class org.xnio.conduits.AbstractSinkConduit

awaitWritable, awaitWritable, flush, getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, wakeupWrites

Methods inherited from class org.xnio.conduits.AbstractConduit

getWorker

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xnio.conduits.SinkConduit

awaitWritable, awaitWritable, flush, getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, wakeupWrites

Methods inherited from interface org.xnio.conduits.Conduit

getWorker

Constructor Detail

AbstractFramedStreamSinkConduit

protected AbstractFramedStreamSinkConduit(StreamSinkConduit next)

Construct a new instance.

Parameters:

next - the delegate conduit to set

Method Detail

queueFrame

protected void queueFrame(AbstractFramedStreamSinkConduit.FrameCallBack callback,
                          ByteBuffer... data)

Queues a frame for sending.

Parameters:

callback -

data -

transferFrom

public long transferFrom(FileChannel src,
                         long position,
                         long count)
                  throws IOException

Description copied from interface: StreamSinkConduit

Transfer bytes into this conduit from the given file.

Specified by:

transferFrom in interface StreamSinkConduit

Overrides:

transferFrom in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

src - the file to read from

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

the number of bytes (possibly 0) that were actually transferred

Throws:

IOException - if an I/O error occurs

transferFrom

public long transferFrom(StreamSourceChannel source,
                         long count,
                         ByteBuffer throughBuffer)
                  throws IOException

Description copied from interface: StreamSinkConduit

Transfers bytes from the given channel source. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from source which must be written to this channel to complete the operation.

Specified by:

transferFrom in interface StreamSinkConduit

Overrides:

transferFrom in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

source - the source to read from

count - the number of bytes to be transferred

throughBuffer - the buffer to copy through.

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

Throws:

IOException - if an I/O error occurs

write

public int write(ByteBuffer src)
          throws IOException

Description copied from interface: StreamSinkConduit

Writes a sequence of bytes to this conduit from the given buffer.

Specified by:

write in interface StreamSinkConduit

Overrides:

write in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

src - the buffer containing data to write

Returns:

the number of bytes written, possibly 0

Throws:

ClosedChannelException - if this conduit's SinkConduit.terminateWrites() method was previously called

IOException - if an error occurs

write

public long write(ByteBuffer[] srcs,
                  int offs,
                  int len)
           throws IOException

Description copied from interface: StreamSinkConduit

Writes a sequence of bytes to this conduit from the given buffers.

Specified by:

write in interface StreamSinkConduit

Overrides:

write in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

srcs - the buffers containing data to write

offs - the offset into the buffer array

len - the number of buffers to write

Returns:

the number of bytes written, possibly 0

Throws:

ClosedChannelException - if this conduit's SinkConduit.terminateWrites() method was previously called

IOException - if an error occurs

writeFinal

public int writeFinal(ByteBuffer src)
               throws IOException

Description copied from interface: StreamSinkConduit

Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer). If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to: int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }

Specified by:

writeFinal in interface StreamSinkConduit

Overrides:

writeFinal in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

src - The data to write

Returns:

The amount of data that was actually written.

Throws:

IOException

writeFinal

public long writeFinal(ByteBuffer[] srcs,
                       int offs,
                       int len)
                throws IOException

Description copied from interface: StreamSinkConduit

Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer[], int, int). If all the data is written out then the conduit will have its writes terminated.

Specified by:

writeFinal in interface StreamSinkConduit

Overrides:

writeFinal in class AbstractStreamSinkConduit<StreamSinkConduit>

Parameters:

srcs - The buffers from which bytes are to be retrieved

offs - The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

len - The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:

The amount of data that was actually written

Throws:

IOException

queuedDataLength

protected long queuedDataLength()

terminateWrites

public void terminateWrites()
                     throws IOException

Description copied from interface: SinkConduit

Signal that no more write data is forthcoming. The conduit must be SinkConduit.flush()ed before it is considered to be shut down.

Specified by:

terminateWrites in interface SinkConduit

Overrides:

terminateWrites in class AbstractSinkConduit<StreamSinkConduit>

Throws:

IOException

doTerminateWrites

protected void doTerminateWrites()
                          throws IOException

Throws:

IOException

flushQueuedData

protected boolean flushQueuedData()
                           throws IOException

Throws:

IOException

truncateWrites

public void truncateWrites()
                    throws IOException

Description copied from interface: SinkConduit

Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.

Specified by:

truncateWrites in interface SinkConduit

Overrides:

truncateWrites in class AbstractSinkConduit<StreamSinkConduit>

Throws:

IOException - if channel termination failed for some reason

isWritesTerminated

protected boolean isWritesTerminated()

queueCloseFrames

protected void queueCloseFrames()

finished

protected void finished()