Package org.apache.catalina.connector
Class CoyoteInputStream
- java.lang.Object
-
- java.io.InputStream
-
- jakarta.servlet.ServletInputStream
-
- org.apache.catalina.connector.CoyoteInputStream
-
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable
public class CoyoteInputStream extends ServletInputStream
This class handles reading bytes.- Author:
- Remy Maucherat
-
-
Field Summary
Fields Modifier and Type Field Description protected InputBufferibprotected static StringManagersm
-
Constructor Summary
Constructors Modifier Constructor Description protectedCoyoteInputStream(InputBuffer ib)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intavailable()protected java.lang.Objectclone()Prevent cloning the facade.voidclose()Close the stream Since we re-cycle, we can't allow the call to super.close() which would permanently disable us.booleanisFinished()Has the end of this InputStream been reached?booleanisReady()Can data be read from this InputStream without blocking?intread()intread(byte[] b)intread(byte[] b, int off, int len)intread(java.nio.ByteBuffer b)Transfers bytes from the buffer to the specified ByteBuffer.voidsetReadListener(ReadListener listener)Sets theReadListenerfor thisServletInputStreamand thereby switches to non-blocking IO.-
Methods inherited from class jakarta.servlet.ServletInputStream
readLine
-
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
ib
protected InputBuffer ib
-
-
Constructor Detail
-
CoyoteInputStream
protected CoyoteInputStream(InputBuffer ib)
-
-
Method Detail
-
clone
protected java.lang.Object clone() throws java.lang.CloneNotSupportedExceptionPrevent cloning the facade.- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.CloneNotSupportedException
-
read
public int read() throws java.io.IOException- Specified by:
readin classjava.io.InputStream- Throws:
java.io.IOException
-
available
public int available() throws java.io.IOException- Overrides:
availablein classjava.io.InputStream- Throws:
java.io.IOException
-
read
public int read(byte[] b) throws java.io.IOException- Overrides:
readin classjava.io.InputStream- Throws:
java.io.IOException
-
read
public int read(byte[] b, int off, int len) throws java.io.IOException- Overrides:
readin classjava.io.InputStream- Throws:
java.io.IOException
-
read
public int read(java.nio.ByteBuffer b) throws java.io.IOExceptionTransfers bytes from the buffer to the specified ByteBuffer. After the operation the position of the ByteBuffer will be returned to the one before the operation, the limit will be the position incremented by the number of the transferred bytes.- Parameters:
b- the ByteBuffer into which bytes are to be written.- Returns:
- an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
- Throws:
java.io.IOException- if an input or output exception has occurred
-
close
public void close() throws java.io.IOExceptionClose the stream Since we re-cycle, we can't allow the call to super.close() which would permanently disable us.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Overrides:
closein classjava.io.InputStream- Throws:
java.io.IOException
-
isFinished
public boolean isFinished()
Description copied from class:jakarta.servlet.ServletInputStreamHas the end of this InputStream been reached?- Specified by:
isFinishedin classServletInputStream- Returns:
trueif all the data has been read from the stream, elsefalse
-
isReady
public boolean isReady()
Description copied from class:jakarta.servlet.ServletInputStreamCan data be read from this InputStream without blocking? Returns If this method is called and returns false, the container will invokeReadListener.onDataAvailable()when data is available.- Specified by:
isReadyin classServletInputStream- Returns:
trueif data can be read without blocking, elsefalse
-
setReadListener
public void setReadListener(ReadListener listener)
Description copied from class:jakarta.servlet.ServletInputStreamSets theReadListenerfor thisServletInputStreamand thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.- Specified by:
setReadListenerin classServletInputStream- Parameters:
listener- The non-blocking IO read listener
-
-