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 voidclose()voidflush()booleanisReady()Checks if a non-blocking write will succeed.voidsetWriteListener(WriteListener listener)Sets theWriteListenerfor thisServletOutputStreamand thereby switches to non-blocking IO.voidwrite(byte[] b, int off, int len)voidwrite(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.ServletOutputStreamChecks 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 returnsfalseno further data must be written until the container callsWriteListener.onWritePossible().- Specified by:
isReadyin classServletOutputStream- Returns:
trueif data can be written, elsefalse
-
setWriteListener
public final void setWriteListener(WriteListener listener)
Description copied from class:jakarta.servlet.ServletOutputStreamSets theWriteListenerfor thisServletOutputStreamand 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:
setWriteListenerin classServletOutputStream- Parameters:
listener- The non-blocking IO write listener
-
write
public void write(int b) throws java.io.IOException- Specified by:
writein classjava.io.OutputStream- Throws:
java.io.IOException
-
write
public void write(byte[] b, int off, int len) throws java.io.IOException- Overrides:
writein classjava.io.OutputStream- Throws:
java.io.IOException
-
flush
public void flush() throws java.io.IOException- Specified by:
flushin interfacejava.io.Flushable- Overrides:
flushin classjava.io.OutputStream- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Overrides:
closein classjava.io.OutputStream- Throws:
java.io.IOException
-
-