Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	UpgradeServletInputStream.ServletInputStreamChannelListener

Field Summary

Modifier and Type	Field and Description
private final ByteBufferPool	bufferPool
private final StreamSourceChannel	channel
private static final int	FLAG_CLOSED
private static final int	FLAG_FINISHED
private static final int	FLAG_ON_DATA_READ_CALLED
private static final int	FLAG_READY If this stream is ready for a read
private final Executor	ioExecutor
private volatile ReadListener	listener
private PooledByteBuffer	pooled
private int	state

Constructor Summary

Access	Constructor and Description
public	UpgradeServletInputStream(final StreamSourceChannel channel, final ByteBufferPool bufferPool, Executor ioExecutor)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public boolean	isFinished() Implements abstract jakarta.servlet.ServletInputStream.isFinished. Returns true when all the data from the stream has been read else it returns false.
public boolean	isReady() Implements abstract jakarta.servlet.ServletInputStream.isReady. Returns true if data can be read without blocking else returns false.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. b) Overrides java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`.
public int	read(final byte[] the buffer into which the data is read. b, final int the start offset in array `b` at which the data is written. off, final int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
private void	readIntoBuffer()
private void	readIntoBufferNonBlocking()
public void	setReadListener(final ReadListener the `ReadListener` that should be notified when it's possible to read. readListener) Implements abstract jakarta.servlet.ServletInputStream.setReadListener. Instructs the `ServletInputStream` to invoke the provided `ReadListener` when it is possible to read

Inherited from jakarta.servlet.ServletInputStream:: readLine

Field Detail

bufferPool	back to summary
private final ByteBufferPool bufferPool

channel	back to summary
private final StreamSourceChannel channel

FLAG_CLOSED	back to summary
private static final int FLAG_CLOSED

FLAG_FINISHED	back to summary
private static final int FLAG_FINISHED

FLAG_ON_DATA_READ_CALLED	back to summary
private static final int FLAG_ON_DATA_READ_CALLED

FLAG_READY	back to summary
private static final int FLAG_READY If this stream is ready for a read

ioExecutor	back to summary
private final Executor ioExecutor

listener	back to summary
private volatile ReadListener listener

pooled	back to summary
private PooledByteBuffer pooled

state	back to summary
private int state

Constructor Detail

UpgradeServletInputStream	back to summary
public UpgradeServletInputStream(final StreamSourceChannel channel, final ByteBufferPool bufferPool, Executor ioExecutor)

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

isFinished back to summary

isFinished	back to summary
public boolean isFinished() Implements abstract jakarta.servlet.ServletInputStream.isFinished. Doc from jakarta.servlet.ServletInputStream.isFinished. Returns true when all the data from the stream has been read else it returns false. Returns:boolean `true` when all data for this particular request has been read, otherwise returns `false`. Annotations @Override

public boolean isFinished()

Implements abstract jakarta.servlet.ServletInputStream.isFinished.

Doc from jakarta.servlet.ServletInputStream.isFinished.

Returns true when all the data from the stream has been read else it returns false.

Returns:boolean

true when all data for this particular request has been read, otherwise returns false.

Annotations

@Override

isReady back to summary

isReady	back to summary
public boolean isReady() Implements abstract jakarta.servlet.ServletInputStream.isReady. Doc from jakarta.servlet.ServletInputStream.isReady. Returns true if data can be read without blocking else returns false. If this method returns false and a `ReadListener` has been set via `setReadListener(ReadListener)`, then the container will subsequently invoke `ReadListener#onDataAvailable()` (or `ReadListener#onAllDataRead()`) once data (or EOF) has become available. Other than the initial call, `ReadListener#onDataAvailable()` will only be called if and only if this method is called and returns false. Returns:boolean `true` if data can be obtained without blocking, otherwise returns `false`. Annotations @Override

public boolean isReady()

Implements abstract jakarta.servlet.ServletInputStream.isReady.

Doc from jakarta.servlet.ServletInputStream.isReady.

Returns true if data can be read without blocking else returns false.

If this method returns false and a ReadListener has been set via setReadListener(ReadListener), then the container will subsequently invoke ReadListener#onDataAvailable() (or ReadListener#onAllDataRead()) once data (or EOF) has become available. Other than the initial call, ReadListener#onDataAvailable() will only be called if and only if this method is called and returns false.

Returns:boolean

true if data can be obtained without blocking, otherwise returns false.

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] b) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads some number of bytes from the input stream and stores them into the buffer array `b`. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If the length of `b` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[0]`, the next one into `b[1]`, and so on. The number of bytes read is, at most, equal to the length of `b`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[0]` through `b[`k`-1]`, leaving elements `b[`k`]` through `b[b.length-1]` unaffected. Parameters b:byte[] the buffer into which the data is read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

public int read(final byte[] b) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at the end of the file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

Parameters

b:byte[]: the buffer into which the data is read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] b, final int off, final int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

public int read(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

readIntoBuffer	back to summary
private void readIntoBuffer() throws IOException

readIntoBufferNonBlocking	back to summary
private void readIntoBufferNonBlocking() throws IOException

setReadListener back to summary

setReadListener	back to summary
public void setReadListener(final ReadListener readListener) Implements abstract jakarta.servlet.ServletInputStream.setReadListener. Doc from jakarta.servlet.ServletInputStream.setReadListener. Instructs the `ServletInputStream` to invoke the provided `ReadListener` when it is possible to read Parameters readListener:ReadListener the `ReadListener` that should be notified when it's possible to read. Annotations @Override

public void setReadListener(final ReadListener readListener)

Implements abstract jakarta.servlet.ServletInputStream.setReadListener.

Doc from jakarta.servlet.ServletInputStream.setReadListener.

Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read

Parameters

readListener:ReadListener: the ReadListener that should be notified when it's possible to read.

Annotations

@Override

io.undertow.servlet.spec back to summary

private Class UpgradeServletInputStream.ServletInputStreamChannelListener

Class Inheritance

extends Object
implements ChannelListener<StreamSourceChannel>

java.lang.Object
io.undertow.servlet.spec.UpgradeServletInputStream.ServletInputStreamChannelListener

All Implemented Interfaces

org.xnio.ChannelListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	ServletInputStreamChannelListener()

Method Summary

Modifier and Type	Method and Description
public void	handleEvent(final StreamSourceChannel the channel event channel) Implements org.xnio.ChannelListener.handleEvent. Handle the event on this channel.

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

Constructor Detail

ServletInputStreamChannelListener	back to summary
private ServletInputStreamChannelListener()

Method Detail

handleEvent	back to summary
public void handleEvent(final StreamSourceChannel channel) Implements org.xnio.ChannelListener.handleEvent. Doc from org.xnio.ChannelListener.handleEvent. Handle the event on this channel. Parameters channel:StreamSourceChannel the channel event Annotations @Override

handleEvent

back to summary

public void handleEvent(final StreamSourceChannel channel)

Implements org.xnio.ChannelListener.handleEvent.

Doc from org.xnio.ChannelListener.handleEvent.

Handle the event on this channel.

Parameters