Package io.undertow.conduits

Class IdleTimeoutConduit

java.lang.Object

io.undertow.conduits.IdleTimeoutConduit

All Implemented Interfaces:

org.xnio.conduits.Conduit, org.xnio.conduits.SinkConduit, org.xnio.conduits.SourceConduit, org.xnio.conduits.StreamSinkConduit, org.xnio.conduits.StreamSourceConduit

public class IdleTimeoutConduit
extends java.lang.Object
implements org.xnio.conduits.StreamSinkConduit, org.xnio.conduits.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	Description
IdleTimeoutConduit(org.xnio.StreamConnection connection)

Method Summary

Modifier and Type	Method	Description
void	awaitReadable()
void	awaitReadable(long time, java.util.concurrent.TimeUnit timeUnit)
void	awaitWritable()
void	awaitWritable(long time, java.util.concurrent.TimeUnit timeUnit)
protected void	doClose()
boolean	flush()
long	getIdleTimeout()
org.xnio.XnioIoThread	getReadThread()
org.xnio.XnioWorker	getWorker()
org.xnio.XnioIoThread	getWriteThread()
boolean	isReadResumed()
boolean	isReadShutdown()
boolean	isWriteResumed()
boolean	isWriteShutdown()
int	read(java.nio.ByteBuffer dst)
long	read(java.nio.ByteBuffer[] dsts, int offset, int length)
void	resumeReads()
void	resumeWrites()
void	setIdleTimeout(long idleTimeout)
void	setReadReadyHandler(org.xnio.conduits.ReadReadyHandler handler)
void	setWriteReadyHandler(org.xnio.conduits.WriteReadyHandler handler)
void	suspendReads()
void	suspendWrites()
void	terminateReads()
void	terminateWrites()
long	transferFrom(java.nio.channels.FileChannel src, long position, long count)
long	transferFrom(org.xnio.channels.StreamSourceChannel source, long count, java.nio.ByteBuffer throughBuffer)
long	transferTo(long position, long count, java.nio.channels.FileChannel target)
long	transferTo(long count, java.nio.ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
void	truncateWrites()
void	wakeupReads()
void	wakeupWrites()
int	write(java.nio.ByteBuffer src)
long	write(java.nio.ByteBuffer[] srcs, int offset, int length)
int	writeFinal(java.nio.ByteBuffer src)
long	writeFinal(java.nio.ByteBuffer[] srcs, int offset, int length)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdleTimeoutConduit

public IdleTimeoutConduit(org.xnio.StreamConnection connection)

Method Detail

doClose

protected void doClose()

write

public int write(java.nio.ByteBuffer src)
          throws java.io.IOException

Specified by:

write in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

write

public long write(java.nio.ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws java.io.IOException

Specified by:

write in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

writeFinal

public int writeFinal(java.nio.ByteBuffer src)
               throws java.io.IOException

Specified by:

writeFinal in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

writeFinal

public long writeFinal(java.nio.ByteBuffer[] srcs,
                       int offset,
                       int length)
                throws java.io.IOException

Specified by:

writeFinal in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

transferTo

public long transferTo(long position,
                       long count,
                       java.nio.channels.FileChannel target)
                throws java.io.IOException

Specified by:

transferTo in interface org.xnio.conduits.StreamSourceConduit

Throws:

java.io.IOException

transferTo

public long transferTo(long count,
                       java.nio.ByteBuffer throughBuffer,
                       org.xnio.channels.StreamSinkChannel target)
                throws java.io.IOException

Specified by:

transferTo in interface org.xnio.conduits.StreamSourceConduit

Throws:

java.io.IOException

read

public long read(java.nio.ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws java.io.IOException

Specified by:

read in interface org.xnio.conduits.StreamSourceConduit

Throws:

java.io.IOException

read

public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException

Specified by:

read in interface org.xnio.conduits.StreamSourceConduit

Throws:

java.io.IOException

transferFrom

public long transferFrom(java.nio.channels.FileChannel src,
                         long position,
                         long count)
                  throws java.io.IOException

Specified by:

transferFrom in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

transferFrom

public long transferFrom(org.xnio.channels.StreamSourceChannel source,
                         long count,
                         java.nio.ByteBuffer throughBuffer)
                  throws java.io.IOException

Specified by:

transferFrom in interface org.xnio.conduits.StreamSinkConduit

Throws:

java.io.IOException

suspendReads

public void suspendReads()

Specified by:

suspendReads in interface org.xnio.conduits.SourceConduit

terminateReads

public void terminateReads()
                    throws java.io.IOException

Specified by:

terminateReads in interface org.xnio.conduits.SourceConduit

Throws:

java.io.IOException

isReadShutdown

public boolean isReadShutdown()

Specified by:

isReadShutdown in interface org.xnio.conduits.SourceConduit

resumeReads

public void resumeReads()

Specified by:

resumeReads in interface org.xnio.conduits.SourceConduit

isReadResumed

public boolean isReadResumed()

Specified by:

isReadResumed in interface org.xnio.conduits.SourceConduit

wakeupReads

public void wakeupReads()

Specified by:

wakeupReads in interface org.xnio.conduits.SourceConduit

awaitReadable

public void awaitReadable()
                   throws java.io.IOException

Specified by:

awaitReadable in interface org.xnio.conduits.SourceConduit

Throws:

java.io.IOException

awaitReadable

public void awaitReadable(long time,
                          java.util.concurrent.TimeUnit timeUnit)
                   throws java.io.IOException

Specified by:

awaitReadable in interface org.xnio.conduits.SourceConduit

Throws:

java.io.IOException

getReadThread

public org.xnio.XnioIoThread getReadThread()

Specified by:

getReadThread in interface org.xnio.conduits.SourceConduit

setReadReadyHandler

public void setReadReadyHandler(org.xnio.conduits.ReadReadyHandler handler)

Specified by:

setReadReadyHandler in interface org.xnio.conduits.SourceConduit

terminateWrites

public void terminateWrites()
                     throws java.io.IOException

Specified by:

terminateWrites in interface org.xnio.conduits.SinkConduit

Throws:

java.io.IOException

isWriteShutdown

public boolean isWriteShutdown()

Specified by:

isWriteShutdown in interface org.xnio.conduits.SinkConduit

resumeWrites

public void resumeWrites()

Specified by:

resumeWrites in interface org.xnio.conduits.SinkConduit

suspendWrites

public void suspendWrites()

Specified by:

suspendWrites in interface org.xnio.conduits.SinkConduit

wakeupWrites

public void wakeupWrites()

Specified by:

wakeupWrites in interface org.xnio.conduits.SinkConduit

isWriteResumed

public boolean isWriteResumed()

Specified by:

isWriteResumed in interface org.xnio.conduits.SinkConduit

awaitWritable

public void awaitWritable()
                   throws java.io.IOException

Specified by:

awaitWritable in interface org.xnio.conduits.SinkConduit

Throws:

java.io.IOException

awaitWritable

public void awaitWritable(long time,
                          java.util.concurrent.TimeUnit timeUnit)
                   throws java.io.IOException

Specified by:

awaitWritable in interface org.xnio.conduits.SinkConduit

Throws:

java.io.IOException

getWriteThread

public org.xnio.XnioIoThread getWriteThread()

Specified by:

getWriteThread in interface org.xnio.conduits.SinkConduit

setWriteReadyHandler

public void setWriteReadyHandler(org.xnio.conduits.WriteReadyHandler handler)

Specified by:

setWriteReadyHandler in interface org.xnio.conduits.SinkConduit

truncateWrites

public void truncateWrites()
                    throws java.io.IOException

Specified by:

truncateWrites in interface org.xnio.conduits.SinkConduit

Throws:

java.io.IOException

flush

public boolean flush()
              throws java.io.IOException

Specified by:

flush in interface org.xnio.conduits.SinkConduit

Throws:

java.io.IOException

getWorker

public org.xnio.XnioWorker getWorker()

Specified by:

getWorker in interface org.xnio.conduits.Conduit

getIdleTimeout

public long getIdleTimeout()

setIdleTimeout

public void setIdleTimeout(long idleTimeout)