Package org.apache.coyote.http11.upgrade
Class UpgradeServletOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- jakarta.servlet.ServletOutputStream
-
- org.apache.coyote.http11.upgrade.UpgradeServletOutputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
public class UpgradeServletOutputStream extends ServletOutputStream
-
-
Constructor Summary
Constructors Constructor Description UpgradeServletOutputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
void
flush()
boolean
isReady()
Checks if a non-blocking write will succeed.void
setWriteListener(WriteListener listener)
Sets theWriteListener
for thisServletOutputStream
and thereby switches to non-blocking IO.void
write(byte[] b, int off, int len)
void
write(int b)
-
-
-
Constructor Detail
-
UpgradeServletOutputStream
public UpgradeServletOutputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo)
-
-
Method Detail
-
isReady
public final boolean isReady()
Description copied from class:jakarta.servlet.ServletOutputStream
Checks if a non-blocking write will succeed. If this returnsfalse
, it will cause a callback toWriteListener.onWritePossible()
when the buffer has emptied. If this method returnsfalse
no further data must be written until the container callsWriteListener.onWritePossible()
.- Specified by:
isReady
in classServletOutputStream
- Returns:
true
if data can be written, elsefalse
-
setWriteListener
public final void setWriteListener(WriteListener listener)
Description copied from class:jakarta.servlet.ServletOutputStream
Sets theWriteListener
for thisServletOutputStream
and 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:
setWriteListener
in classServletOutputStream
- Parameters:
listener
- The non-blocking IO write listener
-
write
public void write(int b) throws java.io.IOException
- Specified by:
write
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
write
public void write(byte[] b, int off, int len) throws java.io.IOException
- Overrides:
write
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException
- Specified by:
flush
in interfacejava.io.Flushable
- Overrides:
flush
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Overrides:
close
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
-