Undertow 2.3.12.Final · io.undertow.conduits.IdleTimeoutConduit

Modifier and Type	Field and Description
private static final int	DELTA
private volatile long	expireTime
private volatile XnioExecutor.Key	handle
private volatile long	idleTimeout
private volatile ReadReadyHandler	readReadyHandler
private final StreamSinkConduit	sink
private final StreamSourceConduit	source
private volatile boolean	timedOut
private final Runnable	timeoutCommand
private volatile WriteReadyHandler	writeReadyHandler

Access	Constructor and Description
public	IdleTimeoutConduit(StreamConnection connection)

Method Summary

Modifier and Type	Method and Description
public void	awaitReadable() Implements org.xnio.conduits.SourceConduit.awaitReadable. Block until this channel becomes readable again.
public void	awaitReadable(long the time to wait time, TimeUnit the time unit timeUnit) Implements org.xnio.conduits.SourceConduit.awaitReadable. Block until this conduit becomes readable again, or until the timeout expires.
public void	awaitWritable() Implements org.xnio.conduits.SinkConduit.awaitWritable. Block until this channel becomes writable again.
public void	awaitWritable(long the time to wait time, TimeUnit the time unit timeUnit) Implements org.xnio.conduits.SinkConduit.awaitWritable. Block until this conduit becomes writable again, or until the timeout expires.
protected void	doClose()
public boolean	flush() Implements org.xnio.conduits.SinkConduit.flush. Flush out any unwritten, buffered output.
public long	getIdleTimeout()
public XnioIoThread	getReadThread() Implements org.xnio.conduits.SourceConduit.getReadThread. Get the XNIO read thread.
public XnioWorker	getWorker() Implements org.xnio.conduits.Conduit.getWorker. Get the XNIO worker associated with this conduit.
public XnioIoThread	getWriteThread() Implements org.xnio.conduits.SinkConduit.getWriteThread. Get the write thread for this conduit.
private void	handleIdleTimeout()
private void	handleResumeTimeout()
public boolean	isReadResumed() Implements org.xnio.conduits.SourceConduit.isReadResumed. Determine whether read notifications are currently enabled.
public boolean	isReadShutdown() Implements org.xnio.conduits.SourceConduit.isReadShutdown. Determine whether reads have been shut down on this conduit.
public boolean	isWriteResumed() Implements org.xnio.conduits.SinkConduit.isWriteResumed. Determine whether write notifications are currently enabled.
public boolean	isWriteShutdown() Implements org.xnio.conduits.SinkConduit.isWriteShutdown. Determine whether writes have been fully shut down on this conduit.
public long	read(ByteBuffer[] the buffers to fill with data from the conduit dsts, int the offset into the buffer array offset, int the number of buffers to fill length) Implements org.xnio.conduits.StreamSourceConduit.read. Read a sequence of bytes from this conduit to the given buffers.
public int	read(ByteBuffer the buffer to fill with data from the conduit dst) Implements org.xnio.conduits.StreamSourceConduit.read. Read a sequence of bytes from this conduit to the given buffer.
public void	resumeReads() Implements org.xnio.conduits.SourceConduit.resumeReads. Indicate that the conduit's `ReadReadyHandler` should be invoked as soon as data can be read without blocking.
public void	resumeWrites() Implements org.xnio.conduits.SinkConduit.resumeWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked as soon as data can be written without blocking.
private static void	safeClose(final StreamSourceConduit sink)
private static void	safeClose(final StreamSinkConduit sink)
public void	setIdleTimeout(long idleTimeout)
public void	setReadReadyHandler(ReadReadyHandler the filter to receive readiness notifications handler) Implements org.xnio.conduits.SourceConduit.setReadReadyHandler. Set the handler which should receive readiness notifications.
public void	setWriteReadyHandler(WriteReadyHandler the filter to receive readiness notifications handler) Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler. Set the handler which should receive readiness notifications.
public void	suspendReads() Implements org.xnio.conduits.SourceConduit.suspendReads. Indicate that calling the conduit's `ReadReadyHandler` should be suspended.
public void	suspendWrites() Implements org.xnio.conduits.SinkConduit.suspendWrites. Indicate that calling the conduit's `WriteReadyHandler` should be suspended.
public void	terminateReads() Implements org.xnio.conduits.SourceConduit.terminateReads. Indicate that no more data will be read from this conduit.
public void	terminateWrites() Implements org.xnio.conduits.SinkConduit.terminateWrites. Signal that no more write data is forthcoming.
public long	transferFrom(FileChannel the file to read from src, long the position within the file from which the transfer is to begin position, long the number of bytes to be transferred count) Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Transfer bytes into this conduit from the given file.
public long	transferFrom(StreamSourceChannel the source to read from source, long the number of bytes to be transferred count, ByteBuffer the buffer to copy through. throughBuffer) Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Transfers bytes from the given channel source.
public long	transferTo(long the position within the file from which the transfer is to begin position, long the number of bytes to be transferred count, FileChannel the file to write to target) Implements org.xnio.conduits.StreamSourceConduit.transferTo. Transfers bytes into the given file from this channel.
public long	transferTo(long the number of bytes to be transferred count, ByteBuffer the buffer to copy through. throughBuffer, StreamSinkChannel the destination to write to target) Implements org.xnio.conduits.StreamSourceConduit.transferTo. Transfers bytes into the given channel target.
public void	truncateWrites() Implements org.xnio.conduits.SinkConduit.truncateWrites. Terminate writes and discard any outstanding write data.
public void	wakeupReads() Implements org.xnio.conduits.SourceConduit.wakeupReads. Indicate that the conduit's `ReadReadyHandler` should be invoked immediately, and then again as soon as data can be read without blocking.
public void	wakeupWrites() Implements org.xnio.conduits.SinkConduit.wakeupWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked immediately, and then again as soon as data can be written without blocking.
public int	write(ByteBuffer the buffer containing data to write src) Implements org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffer.
public long	write(ByteBuffer[] the buffers containing data to write srcs, int the offset into the buffer array offset, int the number of buffers to write length) Implements org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffers.
public int	writeFinal(ByteBuffer The data to write src) Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer)`.
public long	writeFinal(ByteBuffer[] The buffers from which bytes are to be retrieved srcs, int 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` offset, int The maximum number of buffers to be accessed; must be non-negative and no larger than `srcs.length` - `offset` length) Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer[], int, int)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DELTA	back to summary
private static final int DELTA

expireTime	back to summary
private volatile long expireTime

handle	back to summary
private volatile XnioExecutor.Key handle

idleTimeout	back to summary
private volatile long idleTimeout

readReadyHandler	back to summary
private volatile ReadReadyHandler readReadyHandler

sink	back to summary
private final StreamSinkConduit sink

source	back to summary
private final StreamSourceConduit source

timedOut	back to summary
private volatile boolean timedOut

timeoutCommand	back to summary
private final Runnable timeoutCommand

writeReadyHandler	back to summary
private volatile WriteReadyHandler writeReadyHandler

IdleTimeoutConduit	back to summary
public IdleTimeoutConduit(StreamConnection connection)

Method Detail

awaitReadable	back to summary
public void awaitReadable() throws IOException Implements org.xnio.conduits.SourceConduit.awaitReadable. Doc from org.xnio.conduits.SourceConduit.awaitReadable. Block until this channel becomes readable again. This method may return spuriously before the channel becomes readable. Annotations @Override Exceptions IOException: if an I/O error occurs

awaitReadable

back to summary

public void awaitReadable() throws IOException

Implements org.xnio.conduits.SourceConduit.awaitReadable.

Doc from org.xnio.conduits.SourceConduit.awaitReadable.

Block until this channel becomes readable again. This method may return spuriously before the channel becomes readable.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

awaitReadable	back to summary
public void awaitReadable(long time, TimeUnit timeUnit) throws IOException Implements org.xnio.conduits.SourceConduit.awaitReadable. Doc from org.xnio.conduits.SourceConduit.awaitReadable. Block until this conduit becomes readable again, or until the timeout expires. This method may return spuriously before the conduit becomes readable or the timeout expires. Parameters time:long the time to wait timeUnit:TimeUnit the time unit Annotations @Override Exceptions IOException: if an I/O error occurs

awaitReadable

back to summary

public void awaitReadable(long time, TimeUnit timeUnit) throws IOException

Implements org.xnio.conduits.SourceConduit.awaitReadable.

Doc from org.xnio.conduits.SourceConduit.awaitReadable.

Block until this conduit becomes readable again, or until the timeout expires. This method may return spuriously before the conduit becomes readable or the timeout expires.

Parameters

time:long: the time to wait
timeUnit:TimeUnit: the time unit

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

awaitWritable	back to summary
public void awaitWritable() throws IOException Implements org.xnio.conduits.SinkConduit.awaitWritable. Doc from org.xnio.conduits.SinkConduit.awaitWritable. Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable. Annotations @Override Exceptions IOException: if an I/O error occurs

awaitWritable

back to summary

public void awaitWritable() throws IOException

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

awaitWritable	back to summary
public void awaitWritable(long time, TimeUnit timeUnit) throws IOException Implements org.xnio.conduits.SinkConduit.awaitWritable. Doc from org.xnio.conduits.SinkConduit.awaitWritable. Block until this conduit becomes writable again, or until the timeout expires. This method may return spuriously before the conduit becomes writable or the timeout expires. Parameters time:long the time to wait timeUnit:TimeUnit the time unit Annotations @Override Exceptions IOException: if an I/O error occurs

awaitWritable

back to summary

public void awaitWritable(long time, TimeUnit timeUnit) throws IOException

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this conduit becomes writable again, or until the timeout expires. This method may return spuriously before the conduit becomes writable or the timeout expires.

Parameters

time:long: the time to wait
timeUnit:TimeUnit: the time unit

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

doClose	back to summary
protected void doClose()

flush back to summary

flush	back to summary
public boolean flush() throws IOException Implements org.xnio.conduits.SinkConduit.flush. Doc from org.xnio.conduits.SinkConduit.flush. Flush out any unwritten, buffered output. Returns:boolean `true` if everything is flushed, `false` otherwise Annotations @Override Exceptions IOException: if flush fails

public boolean flush() throws IOException

Implements org.xnio.conduits.SinkConduit.flush.

Doc from org.xnio.conduits.SinkConduit.flush.

Flush out any unwritten, buffered output.

Returns:boolean

true if everything is flushed, false otherwise

Annotations

@Override

Exceptions

IOException:: if flush fails

getIdleTimeout	back to summary
public long getIdleTimeout()

getReadThread	back to summary
public XnioIoThread getReadThread() Implements org.xnio.conduits.SourceConduit.getReadThread. Doc from org.xnio.conduits.SourceConduit.getReadThread. Get the XNIO read thread. Returns:XnioIoThread the XNIO read thread Annotations @Override

getReadThread

back to summary

public XnioIoThread getReadThread()

Implements org.xnio.conduits.SourceConduit.getReadThread.

Doc from org.xnio.conduits.SourceConduit.getReadThread.

Get the XNIO read thread.

Returns:XnioIoThread

the XNIO read thread

Annotations

@Override

getWorker	back to summary
public XnioWorker getWorker() Implements org.xnio.conduits.Conduit.getWorker. Doc from org.xnio.conduits.Conduit.getWorker. Get the XNIO worker associated with this conduit. Returns:XnioWorker the XNIO worker associated with this conduit Annotations @Override

getWorker

back to summary

public XnioWorker getWorker()

Implements org.xnio.conduits.Conduit.getWorker.

Doc from org.xnio.conduits.Conduit.getWorker.

Get the XNIO worker associated with this conduit.

Returns:XnioWorker

the XNIO worker associated with this conduit

Annotations

@Override

getWriteThread back to summary

getWriteThread	back to summary
public XnioIoThread getWriteThread() Implements org.xnio.conduits.SinkConduit.getWriteThread. Doc from org.xnio.conduits.SinkConduit.getWriteThread. Get the write thread for this conduit. Returns:XnioIoThread the thread, or `null` if none is configured or available Annotations @Override

public XnioIoThread getWriteThread()

Implements org.xnio.conduits.SinkConduit.getWriteThread.

Doc from org.xnio.conduits.SinkConduit.getWriteThread.

Get the write thread for this conduit.

Returns:XnioIoThread

the thread, or null if none is configured or available

Annotations

@Override

handleIdleTimeout	back to summary
private void handleIdleTimeout() throws ClosedChannelException

handleResumeTimeout	back to summary
private void handleResumeTimeout()

isReadResumed back to summary

isReadResumed	back to summary
public boolean isReadResumed() Implements org.xnio.conduits.SourceConduit.isReadResumed. Doc from org.xnio.conduits.SourceConduit.isReadResumed. Determine whether read notifications are currently enabled. Returns:boolean `true` if read notifications are enabled Annotations @Override

public boolean isReadResumed()

Implements org.xnio.conduits.SourceConduit.isReadResumed.

Doc from org.xnio.conduits.SourceConduit.isReadResumed.

Determine whether read notifications are currently enabled.

Returns:boolean

true if read notifications are enabled

Annotations

@Override

isReadShutdown back to summary

isReadShutdown	back to summary
public boolean isReadShutdown() Implements org.xnio.conduits.SourceConduit.isReadShutdown. Doc from org.xnio.conduits.SourceConduit.isReadShutdown. Determine whether reads have been shut down on this conduit. Returns:boolean `true` if writes are shut down, `false` otherwise Annotations @Override

public boolean isReadShutdown()

Implements org.xnio.conduits.SourceConduit.isReadShutdown.

Doc from org.xnio.conduits.SourceConduit.isReadShutdown.

Determine whether reads have been shut down on this conduit.

Returns:boolean

true if writes are shut down, false otherwise

Annotations

@Override

isWriteResumed back to summary

isWriteResumed	back to summary
public boolean isWriteResumed() Implements org.xnio.conduits.SinkConduit.isWriteResumed. Doc from org.xnio.conduits.SinkConduit.isWriteResumed. Determine whether write notifications are currently enabled. Returns:boolean `true` if write notifications are enabled Annotations @Override

public boolean isWriteResumed()

Implements org.xnio.conduits.SinkConduit.isWriteResumed.

Doc from org.xnio.conduits.SinkConduit.isWriteResumed.

Determine whether write notifications are currently enabled.

Returns:boolean

true if write notifications are enabled

Annotations

@Override

isWriteShutdown back to summary

isWriteShutdown	back to summary
public boolean isWriteShutdown() Implements org.xnio.conduits.SinkConduit.isWriteShutdown. Doc from org.xnio.conduits.SinkConduit.isWriteShutdown. Determine whether writes have been fully shut down on this conduit. Returns:boolean `true` if writes are fully shut down, `false` otherwise Annotations @Override

public boolean isWriteShutdown()

Implements org.xnio.conduits.SinkConduit.isWriteShutdown.

Doc from org.xnio.conduits.SinkConduit.isWriteShutdown.

Determine whether writes have been fully shut down on this conduit.

Returns:boolean

true if writes are fully shut down, false otherwise

Annotations

@Override

read back to summary

read	back to summary
public long read(ByteBuffer[] dsts, int offset, int length) throws IOException Implements org.xnio.conduits.StreamSourceConduit.read. Doc from org.xnio.conduits.StreamSourceConduit.read. Read a sequence of bytes from this conduit to the given buffers. Parameters dsts:ByteBuffer[] the buffers to fill with data from the conduit offset:int the offset into the buffer array length:int the number of buffers to fill Returns:long the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's `terminateReads()` method was previously called Annotations @Override Exceptions IOException: if an error occurs

public long read(ByteBuffer[] dsts, int offset, int length) throws IOException

Implements org.xnio.conduits.StreamSourceConduit.read.

Doc from org.xnio.conduits.StreamSourceConduit.read.

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

Parameters

dsts:ByteBuffer[]: the buffers to fill with data from the conduit
offset:int: the offset into the buffer array
length:int: the number of buffers to fill

Returns:long

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's terminateReads() method was previously called

Annotations

@Override

Exceptions

IOException:: if an error occurs

read back to summary

read	back to summary
public int read(ByteBuffer dst) throws IOException Implements org.xnio.conduits.StreamSourceConduit.read. Doc from org.xnio.conduits.StreamSourceConduit.read. Read a sequence of bytes from this conduit to the given buffer. Parameters dst:ByteBuffer the buffer to fill with data from the conduit Returns:int the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's `terminateReads()` method was previously called Annotations @Override Exceptions IOException: if an error occurs

public int read(ByteBuffer dst) throws IOException

Implements org.xnio.conduits.StreamSourceConduit.read.

Doc from org.xnio.conduits.StreamSourceConduit.read.

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

Parameters

dst:ByteBuffer: the buffer to fill with data from the conduit

Returns:int

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's terminateReads() method was previously called

Annotations

@Override

Exceptions

IOException:: if an error occurs

resumeReads back to summary

resumeReads	back to summary
public void resumeReads() Implements org.xnio.conduits.SourceConduit.resumeReads. Doc from org.xnio.conduits.SourceConduit.resumeReads. Indicate that the conduit's `ReadReadyHandler` should be invoked as soon as data can be read without blocking. Annotations @Override

public void resumeReads()

Implements org.xnio.conduits.SourceConduit.resumeReads.

Doc from org.xnio.conduits.SourceConduit.resumeReads.

Indicate that the conduit's ReadReadyHandler should be invoked as soon as data can be read without blocking.

Annotations

@Override

resumeWrites back to summary

resumeWrites	back to summary
public void resumeWrites() Implements org.xnio.conduits.SinkConduit.resumeWrites. Doc from org.xnio.conduits.SinkConduit.resumeWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked as soon as data can be written without blocking. Annotations @Override

public void resumeWrites()

Implements org.xnio.conduits.SinkConduit.resumeWrites.

Doc from org.xnio.conduits.SinkConduit.resumeWrites.

Indicate that the conduit's WriteReadyHandler should be invoked as soon as data can be written without blocking.

Annotations

@Override

safeClose	back to summary
private static void safeClose(final StreamSourceConduit sink)

safeClose	back to summary
private static void safeClose(final StreamSinkConduit sink)

setIdleTimeout	back to summary
public void setIdleTimeout(long idleTimeout)

setReadReadyHandler	back to summary
public void setReadReadyHandler(ReadReadyHandler handler) Implements org.xnio.conduits.SourceConduit.setReadReadyHandler. Doc from org.xnio.conduits.SourceConduit.setReadReadyHandler. Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself. Parameters handler:ReadReadyHandler the filter to receive readiness notifications Annotations @Override

setReadReadyHandler

back to summary

public void setReadReadyHandler(ReadReadyHandler handler)

Implements org.xnio.conduits.SourceConduit.setReadReadyHandler.

Doc from org.xnio.conduits.SourceConduit.setReadReadyHandler.

Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself.

Parameters

handler:ReadReadyHandler: the filter to receive readiness notifications

Annotations

@Override

setWriteReadyHandler	back to summary
public void setWriteReadyHandler(WriteReadyHandler handler) Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler. Doc from org.xnio.conduits.SinkConduit.setWriteReadyHandler. Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself. Parameters handler:WriteReadyHandler the filter to receive readiness notifications Annotations @Override

setWriteReadyHandler

back to summary

public void setWriteReadyHandler(WriteReadyHandler handler)

Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler.

Doc from org.xnio.conduits.SinkConduit.setWriteReadyHandler.

Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself.

Parameters

handler:WriteReadyHandler: the filter to receive readiness notifications

Annotations

@Override

suspendReads back to summary

suspendReads	back to summary
public void suspendReads() Implements org.xnio.conduits.SourceConduit.suspendReads. Doc from org.xnio.conduits.SourceConduit.suspendReads. Indicate that calling the conduit's `ReadReadyHandler` should be suspended. Annotations @Override

public void suspendReads()

Implements org.xnio.conduits.SourceConduit.suspendReads.

Doc from org.xnio.conduits.SourceConduit.suspendReads.

Indicate that calling the conduit's ReadReadyHandler should be suspended.

Annotations

@Override

suspendWrites back to summary

suspendWrites	back to summary
public void suspendWrites() Implements org.xnio.conduits.SinkConduit.suspendWrites. Doc from org.xnio.conduits.SinkConduit.suspendWrites. Indicate that calling the conduit's `WriteReadyHandler` should be suspended. Annotations @Override

public void suspendWrites()

Implements org.xnio.conduits.SinkConduit.suspendWrites.

Doc from org.xnio.conduits.SinkConduit.suspendWrites.

Indicate that calling the conduit's WriteReadyHandler should be suspended.

Annotations

@Override

terminateReads	back to summary
public void terminateReads() throws IOException Implements org.xnio.conduits.SourceConduit.terminateReads. Doc from org.xnio.conduits.SourceConduit.terminateReads. Indicate that no more data will be read from this conduit. If unread data exists, an exception may be thrown. Annotations @Override Exceptions IOException: if there was a problem

terminateReads

back to summary

public void terminateReads() throws IOException

Implements org.xnio.conduits.SourceConduit.terminateReads.

Doc from org.xnio.conduits.SourceConduit.terminateReads.

Indicate that no more data will be read from this conduit. If unread data exists, an exception may be thrown.

Annotations

@Override

Exceptions

IOException:: if there was a problem

terminateWrites back to summary

terminateWrites	back to summary
public void terminateWrites() throws IOException Implements org.xnio.conduits.SinkConduit.terminateWrites. Doc from org.xnio.conduits.SinkConduit.terminateWrites. Signal that no more write data is forthcoming. The conduit must be `flush()`ed before it is considered to be shut down. Annotations @Override

public void terminateWrites() throws IOException

Implements org.xnio.conduits.SinkConduit.terminateWrites.

Doc from org.xnio.conduits.SinkConduit.terminateWrites.

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

Annotations

@Override

transferFrom	back to summary
public long transferFrom(FileChannel src, long position, long count) throws IOException Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Doc from org.xnio.conduits.StreamSinkConduit.transferFrom. Transfer bytes into this conduit from the given file. Parameters src:FileChannel the file to read from position:long the position within the file from which the transfer is to begin count:long the number of bytes to be transferred Returns:long the number of bytes (possibly 0) that were actually transferred Annotations @Override Exceptions IOException: if an I/O error occurs

transferFrom

back to summary

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

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfer bytes into this conduit from the given file.

Parameters

src:FileChannel: the file to read from
position:long: the position within the file from which the transfer is to begin
count:long: the number of bytes to be transferred

Returns:long

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

transferFrom back to summary

transferFrom	back to summary
public long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws IOException Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Doc from org.xnio.conduits.StreamSinkConduit.transferFrom. 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. Parameters source:StreamSourceChannel the source to read from count:long the number of bytes to be transferred throughBuffer:ByteBuffer the buffer to copy through. Returns:long the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached Annotations @Override Exceptions IOException: if an I/O error occurs

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

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

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.

Parameters

source:StreamSourceChannel: the source to read from
count:long: the number of bytes to be transferred
throughBuffer:ByteBuffer: the buffer to copy through.

Returns:long

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

transferTo	back to summary
public long transferTo(long position, long count, FileChannel target) throws IOException Implements org.xnio.conduits.StreamSourceConduit.transferTo. Doc from org.xnio.conduits.StreamSourceConduit.transferTo. Transfers bytes into the given file from this channel. Parameters position:long the position within the file from which the transfer is to begin count:long the number of bytes to be transferred target:FileChannel the file to write to Returns:long the number of bytes (possibly 0) that were actually transferred Annotations @Override Exceptions IOException: if an I/O error occurs

transferTo

back to summary

public long transferTo(long position, long count, FileChannel target) throws IOException

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Doc from org.xnio.conduits.StreamSourceConduit.transferTo.

Transfers bytes into the given file from this channel.

Parameters

position:long: the position within the file from which the transfer is to begin
count:long: the number of bytes to be transferred
target:FileChannel: the file to write to

Returns:long

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

transferTo back to summary

transferTo	back to summary
public long transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) throws IOException Implements org.xnio.conduits.StreamSourceConduit.transferTo. Doc from org.xnio.conduits.StreamSourceConduit.transferTo. Transfers bytes into the given channel target. On entry, `throughBuffer` will be cleared. On exit, the buffer will be flipped for emptying, and may possibly 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 this channel which must be written to `target` to complete the operation. Parameters count:long the number of bytes to be transferred throughBuffer:ByteBuffer the buffer to copy through. target:StreamSinkChannel the destination to write to Returns:long the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached Annotations @Override Exceptions IOException: if an I/O error occurs

public long transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) throws IOException

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Doc from org.xnio.conduits.StreamSourceConduit.transferTo.

Transfers bytes into the given channel target. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may possibly 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 this channel which must be written to target to complete the operation.

Parameters

count:long: the number of bytes to be transferred
throughBuffer:ByteBuffer: the buffer to copy through.
target:StreamSinkChannel: the destination to write to

Returns:long

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

truncateWrites	back to summary
public void truncateWrites() throws IOException Implements org.xnio.conduits.SinkConduit.truncateWrites. Doc from org.xnio.conduits.SinkConduit.truncateWrites. Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method. Annotations @Override Exceptions IOException: if channel termination failed for some reason

truncateWrites

back to summary

public void truncateWrites() throws IOException

Implements org.xnio.conduits.SinkConduit.truncateWrites.

Doc from org.xnio.conduits.SinkConduit.truncateWrites.

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

Annotations

@Override

Exceptions

IOException:: if channel termination failed for some reason

wakeupReads back to summary

wakeupReads	back to summary
public void wakeupReads() Implements org.xnio.conduits.SourceConduit.wakeupReads. Doc from org.xnio.conduits.SourceConduit.wakeupReads. Indicate that the conduit's `ReadReadyHandler` should be invoked immediately, and then again as soon as data can be read without blocking. Annotations @Override

public void wakeupReads()

Implements org.xnio.conduits.SourceConduit.wakeupReads.

Doc from org.xnio.conduits.SourceConduit.wakeupReads.

Indicate that the conduit's ReadReadyHandler should be invoked immediately, and then again as soon as data can be read without blocking.

Annotations

@Override

wakeupWrites back to summary

wakeupWrites	back to summary
public void wakeupWrites() Implements org.xnio.conduits.SinkConduit.wakeupWrites. Doc from org.xnio.conduits.SinkConduit.wakeupWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked immediately, and then again as soon as data can be written without blocking. Annotations @Override

public void wakeupWrites()

Implements org.xnio.conduits.SinkConduit.wakeupWrites.

Doc from org.xnio.conduits.SinkConduit.wakeupWrites.

Indicate that the conduit's WriteReadyHandler should be invoked immediately, and then again as soon as data can be written without blocking.

Annotations

@Override

write

back to summary

public int write(ByteBuffer src) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

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

Parameters

src:ByteBuffer: the buffer containing data to write

Returns:int

the number of bytes written, possibly 0

Annotations

@Override

Exceptions

IOException:: if an error occurs

write

back to summary

public long write(ByteBuffer[] srcs, int offset, int length) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

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

Parameters

srcs:ByteBuffer[]: the buffers containing data to write
offset:int: the offset into the buffer array
length:int: the number of buffers to write

Returns:long

the number of bytes written, possibly 0

Annotations

@Override

Exceptions

IOException:: if an error occurs

writeFinal back to summary

public int writeFinal(ByteBuffer src) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as 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() }

Parameters

src:ByteBuffer: The data to write

Returns:int

The amount of data that was actually written.

Annotations

@Override

writeFinal back to summary

public long writeFinal(ByteBuffer[] srcs, int offset, int length) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

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

Parameters

srcs:ByteBuffer[]: The buffers from which bytes are to be retrieved
offset:int: 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
length:int: The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:long

The amount of data that was actually written

Annotations

@Override

public Class IdleTimeoutConduit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail