Package org.apache.catalina.connector
Class CoyoteOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- jakarta.servlet.ServletOutputStream
-
- org.apache.catalina.connector.CoyoteOutputStream
-
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
public class CoyoteOutputStream extends ServletOutputStream
Coyote implementation of the servlet output stream.- Author:
- Costin Manolache, Remy Maucherat
-
-
Field Summary
Fields Modifier and Type Field Description protected OutputBufferobprotected static StringManagersm
-
Constructor Summary
Constructors Modifier Constructor Description protectedCoyoteOutputStream(OutputBuffer ob)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Objectclone()Prevent cloning the facade.voidclose()voidflush()Will send the buffer to the client.booleanisReady()Checks if a non-blocking write will succeed.voidsetWriteListener(WriteListener listener)Sets theWriteListenerfor thisServletOutputStreamand thereby switches to non-blocking IO.voidwrite(byte[] b)voidwrite(byte[] b, int off, int len)voidwrite(int i)voidwrite(ByteBuffer from)-
Methods inherited from class jakarta.servlet.ServletOutputStream
print, print, print, print, print, print, print, println, println, println, println, println, println, println, println
-
Methods inherited from class java.io.OutputStream
nullOutputStream
-
-
-
-
Field Detail
-
sm
protected static final StringManager sm
-
ob
protected OutputBuffer ob
-
-
Constructor Detail
-
CoyoteOutputStream
protected CoyoteOutputStream(OutputBuffer ob)
-
-
Method Detail
-
clone
protected Object clone() throws CloneNotSupportedException
Prevent cloning the facade.- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-
write
public void write(int i) throws IOException- Specified by:
writein classOutputStream- Throws:
IOException
-
write
public void write(byte[] b) throws IOException- Overrides:
writein classOutputStream- Throws:
IOException
-
write
public void write(byte[] b, int off, int len) throws IOException- Overrides:
writein classOutputStream- Throws:
IOException
-
write
public void write(ByteBuffer from) throws IOException
- Throws:
IOException
-
flush
public void flush() throws IOExceptionWill send the buffer to the client.- Specified by:
flushin interfaceFlushable- Overrides:
flushin classOutputStream- Throws:
IOException
-
close
public void close() throws IOException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classOutputStream- Throws:
IOException
-
isReady
public 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 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
-
-