Modifier and Type	Class and Description
public static class	BlockingReadTimeoutHandler.Builder
private static class	BlockingReadTimeoutHandler.TimeoutStreamSourceConduit
private static class	BlockingReadTimeoutHandler.TimeoutStreamSourceConduitWrapper

Modifier and Type	Field and Description
private final HttpHandler	next
private final ConduitWrapper<StreamSourceConduit>	streamSourceConduitWrapper

Access	Constructor and Description
private	BlockingReadTimeoutHandler(HttpHandler next, Duration readTimeout)

Modifier and Type	Method and Description
public static BlockingReadTimeoutHandler.Builder	builder()
public void	handleRequest(HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.

next	back to summary
private final HttpHandler next

streamSourceConduitWrapper	back to summary
private final ConduitWrapper<StreamSourceConduit> streamSourceConduitWrapper

BlockingReadTimeoutHandler	back to summary
private BlockingReadTimeoutHandler(HttpHandler next, Duration readTimeout)

builder	back to summary
public static BlockingReadTimeoutHandler.Builder builder()

handleRequest	back to summary
public void handleRequest(HttpServerExchange exchange) throws Exception Implements io.undertow.server.HttpHandler.handleRequest. Doc from io.undertow.server.HttpHandler.handleRequest. Handle the request. Parameters exchange:HttpServerExchange the HTTP request/response exchange Annotations @Override

Modifier and Type	Field and Description
private HttpHandler	nextHandler
private Duration	readTimeout

Access	Constructor and Description
private	Builder()

Modifier and Type	Method and Description
public HttpHandler	build()
public BlockingReadTimeoutHandler.Builder	nextHandler(HttpHandler nextHandler)
public BlockingReadTimeoutHandler.Builder	readTimeout(Duration readTimeout)

nextHandler	back to summary
private HttpHandler nextHandler

readTimeout	back to summary
private Duration readTimeout

Builder	back to summary
private Builder()

build	back to summary
public HttpHandler build()

nextHandler	back to summary
public BlockingReadTimeoutHandler.Builder nextHandler(HttpHandler nextHandler)

readTimeout	back to summary
public BlockingReadTimeoutHandler.Builder readTimeout(Duration readTimeout)

io.undertow.server.handlers back to summary

private final Class BlockingReadTimeoutHandler.TimeoutStreamSourceConduit

Class Inheritance

extends Object
implements StreamSourceConduit

java.lang.Object
io.undertow.server.handlers.BlockingReadTimeoutHandler.TimeoutStreamSourceConduit

All Implemented Interfaces

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

Field Summary

Modifier and Type	Field and Description
private final StreamSourceConduit	delegate
private long	remaining
private final ServerConnection	serverConnection
private final long	timeoutNanos

Constructor Summary

Access	Constructor and Description
pack-priv	TimeoutStreamSourceConduit(StreamSourceConduit delegate, ServerConnection serverConnection, long timeoutNanos)

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 duration, TimeUnit the time unit unit) Implements org.xnio.conduits.SourceConduit.awaitReadable. Block until this conduit becomes readable again, or until the timeout expires.
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 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 int	read(ByteBuffer the buffer to fill with data from the conduit byteBuffer) Implements org.xnio.conduits.StreamSourceConduit.read. Read a sequence of bytes from this conduit to the given buffer.
public long	read(ByteBuffer[] the buffers to fill with data from the conduit byteBuffers, 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.
private long	resetTimeoutIfReadSucceeded(long value)
private int	resetTimeoutIfReadSucceeded(int value)
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	setReadReadyHandler(ReadReadyHandler the filter to receive readiness notifications readReadyHandler) Implements org.xnio.conduits.SourceConduit.setReadReadyHandler. 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	terminateReads() Implements org.xnio.conduits.SourceConduit.terminateReads. Indicate that no more data will be read from this conduit.
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 fileChannel) 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. byteBuffer, StreamSinkChannel the destination to write to streamSinkChannel) Implements org.xnio.conduits.StreamSourceConduit.transferTo. Transfers bytes into the given channel target.
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.

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

Field Detail

delegate	back to summary
private final StreamSourceConduit delegate

remaining	back to summary
private long remaining

serverConnection	back to summary
private final ServerConnection serverConnection

timeoutNanos	back to summary
private final long timeoutNanos

Constructor Detail

TimeoutStreamSourceConduit	back to summary
pack-priv TimeoutStreamSourceConduit(StreamSourceConduit delegate, ServerConnection serverConnection, long timeoutNanos)

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 duration, TimeUnit unit) 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 duration:long the time to wait unit:TimeUnit the time unit Annotations @Override Exceptions IOException: if an I/O error occurs

awaitReadable

back to summary

public void awaitReadable(long duration, TimeUnit unit) 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

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

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

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

read back to summary

read	back to summary
public int read(ByteBuffer byteBuffer) 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 byteBuffer: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 byteBuffer) 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

byteBuffer: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

read back to summary

read	back to summary
public long read(ByteBuffer[] byteBuffers, 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 byteBuffers: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[] byteBuffers, 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

byteBuffers: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

resetTimeoutIfReadSucceeded	back to summary
private long resetTimeoutIfReadSucceeded(long value)

resetTimeoutIfReadSucceeded	back to summary
private int resetTimeoutIfReadSucceeded(int value)

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

setReadReadyHandler	back to summary
public void setReadReadyHandler(ReadReadyHandler readReadyHandler) 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 readReadyHandler:ReadReadyHandler the filter to receive readiness notifications Annotations @Override

setReadReadyHandler

back to summary

public void setReadReadyHandler(ReadReadyHandler readReadyHandler)

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

readReadyHandler:ReadReadyHandler: 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

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

transferTo	back to summary
public long transferTo(long position, long count, FileChannel fileChannel) 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 fileChannel: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 fileChannel) 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
fileChannel: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 byteBuffer, StreamSinkChannel streamSinkChannel) 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 byteBuffer:ByteBuffer the buffer to copy through. streamSinkChannel: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 byteBuffer, StreamSinkChannel streamSinkChannel) 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
byteBuffer:ByteBuffer: the buffer to copy through.
streamSinkChannel: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

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

public final Class BlockingReadTimeoutHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BlockingReadTimeoutHandler.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class BlockingReadTimeoutHandler.TimeoutStreamSourceConduit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class BlockingReadTimeoutHandler.TimeoutStreamSourceConduitWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail