io.undertow.conduits

Class IdleTimeoutConduit

java.lang.Object

io.undertow.conduits.IdleTimeoutConduit

All Implemented Interfaces:

Conduit, SinkConduit, SourceConduit, StreamSinkConduit, StreamSourceConduit

public class IdleTimeoutConduit
extends Object
implements StreamSinkConduit, StreamSourceConduit

Conduit that adds support to close a channel once for a specified time no reads and no writes were performed.

Author:

Norman Maurer

Constructor Summary

Constructors

Constructor and Description
IdleTimeoutConduit(StreamConnection connection)

Method Summary

Modifier and Type	Method and Description
void	awaitReadable() Block until this channel becomes readable again.
void	awaitReadable(long time, TimeUnit timeUnit) Block until this conduit becomes readable again, or until the timeout expires.
void	awaitWritable() Block until this channel becomes writable again.
void	awaitWritable(long time, TimeUnit timeUnit) Block until this conduit becomes writable again, or until the timeout expires.
protected void	doClose()
boolean	flush() Flush out any unwritten, buffered output.
long	getIdleTimeout()
XnioIoThread	getReadThread() Get the XNIO read thread.
XnioWorker	getWorker() Get the XNIO worker associated with this conduit.
XnioIoThread	getWriteThread() Get the write thread for this conduit.
boolean	isReadResumed() Determine whether read notifications are currently enabled.
boolean	isReadShutdown() Determine whether reads have been shut down on this conduit.
boolean	isWriteResumed() Determine whether write notifications are currently enabled.
boolean	isWriteShutdown() Determine whether writes have been fully shut down on this conduit.
int	read(ByteBuffer dst) Read a sequence of bytes from this conduit to the given buffer.
long	read(ByteBuffer[] dsts, int offset, int length) Read a sequence of bytes from this conduit to the given buffers.
void	resumeReads() Indicate that the conduit's ReadReadyHandler should be invoked as soon as data can be read without blocking.
void	resumeWrites() Indicate that the conduit's WriteReadyHandler should be invoked as soon as data can be written without blocking.
void	setIdleTimeout(long idleTimeout)
void	setReadReadyHandler(ReadReadyHandler handler) Set the handler which should receive readiness notifications.
void	setWriteReadyHandler(WriteReadyHandler handler) Set the handler which should receive readiness notifications.
void	suspendReads() Indicate that calling the conduit's ReadReadyHandler should be suspended.
void	suspendWrites() Indicate that calling the conduit's WriteReadyHandler should be suspended.
void	terminateReads() Indicate that no more data will be read from this conduit.
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.
long	transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) Transfers bytes into the given channel target.
long	transferTo(long position, long count, FileChannel target) Transfers bytes into the given file from this channel.
void	truncateWrites() Terminate writes and discard any outstanding write data.
void	wakeupReads() Indicate that the conduit's ReadReadyHandler should be invoked immediately, and then again as soon as data can be read without blocking.
void	wakeupWrites() Indicate that the conduit's WriteReadyHandler should be invoked immediately, and then again as soon as data can be written without blocking.
int	write(ByteBuffer src) Writes a sequence of bytes to this conduit from the given buffer.
long	write(ByteBuffer[] srcs, int offset, int length) 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 offset, int length) Writes some data to the conduit, with the same semantics as StreamSinkConduit.write(java.nio.ByteBuffer[], int, int).

Methods inherited from class java.lang.Object

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

Constructor Detail

IdleTimeoutConduit

public IdleTimeoutConduit(StreamConnection connection)

Method Detail

doClose

protected void doClose()

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

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 offset,
                  int length)
           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

Parameters:

srcs - the buffers containing data to write

offset - the offset into the buffer array

length - 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

Parameters:

src - The data to write

Returns:

The amount of data that was actually written.

Throws:

IOException

writeFinal

public long writeFinal(ByteBuffer[] srcs,
                       int offset,
                       int length)
                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

Parameters:

srcs - The buffers from which bytes are to be retrieved

offset - 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 - 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

transferTo

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

Description copied from interface: StreamSourceConduit

Transfers bytes into the given file from this channel.

Specified by:

transferTo in interface StreamSourceConduit

Parameters:

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

count - the number of bytes to be transferred

target - the file to write to

Returns:

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

Throws:

IOException - if an I/O error occurs

transferTo

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

Description copied from interface: StreamSourceConduit

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.

Specified by:

transferTo in interface StreamSourceConduit

Parameters:

count - the number of bytes to be transferred

throughBuffer - the buffer to copy through.

target - the destination to write to

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

read

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

Description copied from interface: StreamSourceConduit

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

Specified by:

read in interface StreamSourceConduit

offset - the offset into the buffer array

length - the number of buffers to fill

Returns:

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

Throws:

IOException - if an error occurs

read

public int read(ByteBuffer dst)
         throws IOException

Description copied from interface: StreamSourceConduit

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

Specified by:

read in interface StreamSourceConduit

Returns:

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

Throws:

IOException - if an error occurs

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

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

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

suspendReads

public void suspendReads()

Description copied from interface: SourceConduit

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

Specified by:

suspendReads in interface SourceConduit

terminateReads

public void terminateReads()
                    throws IOException

Description copied from interface: SourceConduit

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

Specified by:

terminateReads in interface SourceConduit

Throws:

IOException - if there was a problem

isReadShutdown

public boolean isReadShutdown()

Description copied from interface: SourceConduit

Determine whether reads have been shut down on this conduit.

Specified by:

isReadShutdown in interface SourceConduit

Returns:

true if writes are shut down, false otherwise

resumeReads

public void resumeReads()

Description copied from interface: SourceConduit

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

Specified by:

resumeReads in interface SourceConduit

isReadResumed

public boolean isReadResumed()

Description copied from interface: SourceConduit

Determine whether read notifications are currently enabled.

Specified by:

isReadResumed in interface SourceConduit

Returns:

true if read notifications are enabled

wakeupReads

public void wakeupReads()

Description copied from interface: SourceConduit

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

Specified by:

wakeupReads in interface SourceConduit

awaitReadable

public void awaitReadable()
                   throws IOException

Description copied from interface: SourceConduit

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

Specified by:

awaitReadable in interface SourceConduit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

awaitReadable

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

Description copied from interface: SourceConduit

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.

Specified by:

awaitReadable in interface SourceConduit

Parameters:

time - the time to wait

timeUnit - the time unit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

getReadThread

public XnioIoThread getReadThread()

Description copied from interface: SourceConduit

Get the XNIO read thread.

Specified by:

getReadThread in interface SourceConduit

Returns:

the XNIO read thread

setReadReadyHandler

public void setReadReadyHandler(ReadReadyHandler handler)

Description copied from interface: SourceConduit

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.

Specified by:

setReadReadyHandler in interface SourceConduit

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

Throws:

IOException

isWriteShutdown

public boolean isWriteShutdown()

Description copied from interface: SinkConduit

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

Specified by:

isWriteShutdown in interface SinkConduit

Returns:

true if writes are fully shut down, false otherwise

resumeWrites

public void resumeWrites()

Description copied from interface: SinkConduit

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

Specified by:

resumeWrites in interface SinkConduit

suspendWrites

public void suspendWrites()

Description copied from interface: SinkConduit

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

Specified by:

suspendWrites in interface SinkConduit

wakeupWrites

public void wakeupWrites()

Description copied from interface: SinkConduit

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

Specified by:

wakeupWrites in interface SinkConduit

isWriteResumed

public boolean isWriteResumed()

Description copied from interface: SinkConduit

Determine whether write notifications are currently enabled.

Specified by:

isWriteResumed in interface SinkConduit

Returns:

true if write notifications are enabled

awaitWritable

public void awaitWritable()
                   throws IOException

Description copied from interface: SinkConduit

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

Specified by:

awaitWritable in interface SinkConduit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

awaitWritable

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

Description copied from interface: SinkConduit

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.

Specified by:

awaitWritable in interface SinkConduit

Parameters:

time - the time to wait

timeUnit - the time unit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

getWriteThread

public XnioIoThread getWriteThread()

Description copied from interface: SinkConduit

Get the write thread for this conduit.

Specified by:

getWriteThread in interface SinkConduit

Returns:

the thread, or null if none is configured or available

setWriteReadyHandler

public void setWriteReadyHandler(WriteReadyHandler handler)

Description copied from interface: SinkConduit

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.

Specified by:

setWriteReadyHandler in interface SinkConduit

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

Throws:

IOException - if channel termination failed for some reason

flush

public boolean flush()
              throws IOException

Description copied from interface: SinkConduit

Flush out any unwritten, buffered output.

Specified by:

flush in interface SinkConduit

Returns:

true if everything is flushed, false otherwise

Throws:

IOException - if flush fails

getWorker

public XnioWorker getWorker()

Description copied from interface: Conduit

Get the XNIO worker associated with this conduit.

Specified by:

getWorker in interface Conduit

Returns:

the XNIO worker associated with this conduit

getIdleTimeout

public long getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(long idleTimeout)