Package io.undertow.servlet.spec

Class UpgradeServletInputStream

java.lang.Object

java.io.InputStream

jakarta.servlet.ServletInputStream

io.undertow.servlet.spec.UpgradeServletInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class UpgradeServletInputStream
extends ServletInputStream

Servlet input stream implementation. This stream is non-buffered, and is only used for upgraded requests

Author:

Stuart Douglas

Constructor Summary

Constructors

Constructor	Description
UpgradeServletInputStream(org.xnio.channels.StreamSourceChannel channel, ByteBufferPool bufferPool, Executor ioExecutor)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
boolean	isFinished()	Returns true when all the data from the stream has been read else it returns false.
boolean	isReady()	Returns true if data can be read without blocking else returns false.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	setReadListener(ReadListener readListener)	Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read

Methods inherited from class jakarta.servlet.ServletInputStream

readLine

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

UpgradeServletInputStream

public UpgradeServletInputStream(org.xnio.channels.StreamSourceChannel channel,
 ByteBufferPool bufferPool,
 Executor ioExecutor)

Method Details

isFinished

public boolean isFinished()

Description copied from class: ServletInputStream

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

Specified by:

isFinished in class ServletInputStream

Returns:

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

isReady

public boolean isReady()

Description copied from class: ServletInputStream

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

If this method returns false and a ReadListener has been set via ServletInputStream.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.

Specified by:

isReady in class ServletInputStream

Returns:

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

See Also:

• ReadListener

setReadListener

public void setReadListener(ReadListener readListener)

Description copied from class: ServletInputStream

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

Specified by:

setReadListener in class ServletInputStream

Parameters:

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException