Package org.apache.coyote.http11.upgrade
Class UpgradeServletInputStream
java.lang.Object
java.io.InputStream
jakarta.servlet.ServletInputStream
org.apache.coyote.http11.upgrade.UpgradeServletInputStream
- All Implemented Interfaces:
- Closeable,- AutoCloseable
- 
Constructor SummaryConstructorsConstructorDescriptionUpgradeServletInputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo) 
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()final booleanHas the end of this InputStream been reached?final booleanisReady()Can data be read from this InputStream without blocking?final intread()final intread(byte[] b, int off, int len) final intreadLine(byte[] b, int off, int len) Reads the input stream, one line at a time.final voidsetReadListener(ReadListener listener) Sets theReadListenerfor thisServletInputStreamand thereby switches to non-blocking IO.Methods inherited from class java.io.InputStreamavailable, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
- 
Constructor Details- 
UpgradeServletInputStreampublic UpgradeServletInputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo) 
 
- 
- 
Method Details- 
isFinishedpublic final boolean isFinished()Description copied from class:jakarta.servlet.ServletInputStreamHas the end of this InputStream been reached?- Specified by:
- isFinishedin class- ServletInputStream
- Returns:
- trueif all the data has been read from the stream, else- false
 
- 
isReadypublic final 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 class- ServletInputStream
- Returns:
- trueif data can be read without blocking, else- false
 
- 
setReadListenerDescription 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 class- ServletInputStream
- Parameters:
- listener- The non-blocking IO read listener
 
- 
read- Specified by:
- readin class- InputStream
- Throws:
- IOException
 
- 
readLineDescription copied from class:jakarta.servlet.ServletInputStreamReads the input stream, one line at a time. Starting at an offset, reads bytes into an array, until it reads a certain number of bytes or reaches a newline character, which it reads into the array as well.This method returns -1 if it reaches the end of the input stream before reading the maximum number of bytes. - Overrides:
- readLinein class- ServletInputStream
- Parameters:
- b- an array of bytes into which data is read
- off- an integer specifying the character at which this method begins reading
- len- an integer specifying the maximum number of bytes to read
- Returns:
- an integer specifying the actual number of bytes read, or -1 if the end of the stream is reached
- Throws:
- IOException- if an input or output exception has occurred
 
- 
read- Overrides:
- readin class- InputStream
- Throws:
- IOException
 
- 
close- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- InputStream
- Throws:
- IOException
 
 
-