public class HttpOutput
extends javax.servlet.ServletOutputStream
implements java.lang.Runnable
HttpOutput
implements ServletOutputStream
as required by the Servlet specification.
HttpOutput
buffers content written by the application until a
further write will overflow the buffer, at which point it triggers a commit
of the response.
HttpOutput
can be closed and reopened, to allow requests included
via RequestDispatcher.include(ServletRequest, ServletResponse)
to
close the stream, to be reopened after the inclusion ends.
Modifier and Type | Class and Description |
---|---|
private class |
HttpOutput.AsyncFlush |
private class |
HttpOutput.AsyncICB |
private class |
HttpOutput.AsyncWrite |
private class |
HttpOutput.InputStreamWritingCB
An iterating callback that will take content from an
InputStream and write it to the associated
HttpChannel . |
static interface |
HttpOutput.Interceptor
The HttpOutput.Interceptor is a single intercept point for all
output written to the HttpOutput: via writer; via output stream;
asynchronously; or blocking.
|
private static class |
HttpOutput.OutputState |
private class |
HttpOutput.ReadableByteChannelWritingCB
An iterating callback that will take content from a
ReadableByteChannel and write it to the
HttpChannel . |
private static class |
HttpOutput.WriteBlocker |
Modifier and Type | Field and Description |
---|---|
private java.nio.ByteBuffer |
_aggregate |
private int |
_bufferSize |
private HttpChannel |
_channel |
private int |
_commitSize |
private long |
_firstByteTimeStamp |
private long |
_flushed |
private HttpOutput.Interceptor |
_interceptor |
private java.lang.Throwable |
_onError |
private java.util.concurrent.atomic.AtomicReference<HttpOutput.OutputState> |
_state |
private SharedBlockingCallback |
_writeBlocker |
private javax.servlet.WriteListener |
_writeListener |
private long |
_written |
private static Logger |
LOG |
Constructor and Description |
---|
HttpOutput(HttpChannel channel) |
Modifier and Type | Method and Description |
---|---|
private void |
abort(java.lang.Throwable failure) |
protected SharedBlockingCallback.Blocker |
acquireWriteBlockingCallback() |
void |
close() |
private void |
close(java.io.Closeable resource) |
(package private) void |
closed()
Called to indicate that the last write has been performed.
|
void |
flush() |
int |
getBufferSize() |
HttpChannel |
getHttpChannel() |
HttpOutput.Interceptor |
getInterceptor() |
long |
getWritten() |
boolean |
isAllContentWritten() |
boolean |
isAsync() |
boolean |
isClosed() |
private boolean |
isLastContentToWrite(int len) |
boolean |
isReady() |
boolean |
isWritten() |
void |
onFlushed(long bytes)
Invoked when bytes have been flushed to the network.
|
void |
print(java.lang.String s) |
void |
recycle() |
private void |
releaseBuffer() |
void |
reopen() |
void |
resetBuffer() |
void |
run() |
void |
sendContent(java.nio.ByteBuffer content)
Blocking send of whole content.
|
void |
sendContent(java.nio.ByteBuffer content,
Callback callback)
Asynchronous send of whole content.
|
void |
sendContent(HttpContent content)
Blocking send of HTTP content.
|
void |
sendContent(HttpContent httpContent,
Callback callback)
Asynchronous send of HTTP content.
|
void |
sendContent(java.io.InputStream in)
Blocking send of stream content.
|
void |
sendContent(java.io.InputStream in,
Callback callback)
Asynchronous send of stream content.
|
void |
sendContent(java.nio.channels.ReadableByteChannel in)
Blocking send of channel content.
|
void |
sendContent(java.nio.channels.ReadableByteChannel in,
Callback callback)
Asynchronous send of channel content.
|
void |
setBufferSize(int size) |
void |
setInterceptor(HttpOutput.Interceptor interceptor) |
void |
setWriteListener(javax.servlet.WriteListener writeListener) |
java.lang.String |
toString() |
void |
write(byte[] b,
int off,
int len) |
void |
write(java.nio.ByteBuffer buffer) |
private void |
write(java.nio.ByteBuffer content,
boolean complete) |
protected void |
write(java.nio.ByteBuffer content,
boolean complete,
Callback callback) |
void |
write(int b) |
private static Logger LOG
private final HttpChannel _channel
private final SharedBlockingCallback _writeBlocker
private HttpOutput.Interceptor _interceptor
private long _written
private long _flushed
private long _firstByteTimeStamp
private java.nio.ByteBuffer _aggregate
private int _bufferSize
private int _commitSize
private javax.servlet.WriteListener _writeListener
private volatile java.lang.Throwable _onError
private final java.util.concurrent.atomic.AtomicReference<HttpOutput.OutputState> _state
public HttpOutput(HttpChannel channel)
public HttpChannel getHttpChannel()
public HttpOutput.Interceptor getInterceptor()
public void setInterceptor(HttpOutput.Interceptor interceptor)
public boolean isWritten()
public long getWritten()
public void reopen()
private boolean isLastContentToWrite(int len)
public boolean isAllContentWritten()
protected SharedBlockingCallback.Blocker acquireWriteBlockingCallback() throws java.io.IOException
java.io.IOException
private void write(java.nio.ByteBuffer content, boolean complete) throws java.io.IOException
java.io.IOException
protected void write(java.nio.ByteBuffer content, boolean complete, Callback callback)
private void abort(java.lang.Throwable failure)
public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in class java.io.OutputStream
void closed()
private void releaseBuffer()
public boolean isClosed()
public boolean isAsync()
public void flush() throws java.io.IOException
flush
in interface java.io.Flushable
flush
in class java.io.OutputStream
java.io.IOException
public void write(byte[] b, int off, int len) throws java.io.IOException
write
in class java.io.OutputStream
java.io.IOException
public void write(java.nio.ByteBuffer buffer) throws java.io.IOException
java.io.IOException
public void write(int b) throws java.io.IOException
write
in class java.io.OutputStream
java.io.IOException
public void print(java.lang.String s) throws java.io.IOException
print
in class javax.servlet.ServletOutputStream
java.io.IOException
public void sendContent(java.nio.ByteBuffer content) throws java.io.IOException
content
- The whole content to sendjava.io.IOException
- if the send failspublic void sendContent(java.io.InputStream in) throws java.io.IOException
in
- The stream content to sendjava.io.IOException
- if the send failspublic void sendContent(java.nio.channels.ReadableByteChannel in) throws java.io.IOException
in
- The channel content to sendjava.io.IOException
- if the send failspublic void sendContent(HttpContent content) throws java.io.IOException
content
- The HTTP content to sendjava.io.IOException
- if the send failspublic void sendContent(java.nio.ByteBuffer content, Callback callback)
content
- The whole content to sendcallback
- The callback to use to notify success or failurepublic void sendContent(java.io.InputStream in, Callback callback)
in
- The stream content to sendcallback
- The callback to use to notify success or failurepublic void sendContent(java.nio.channels.ReadableByteChannel in, Callback callback)
in
- The channel content to sendcallback
- The callback to use to notify success or failurepublic void sendContent(HttpContent httpContent, Callback callback)
httpContent
- The HTTP content to sendcallback
- The callback to use to notify success or failurepublic int getBufferSize()
public void setBufferSize(int size)
public void onFlushed(long bytes) throws java.io.IOException
Invoked when bytes have been flushed to the network.
The number of flushed bytes may be different from the bytes written
by the application if an HttpOutput.Interceptor
changed them, for example
by compressing them.
bytes
- the number of bytes flushedjava.io.IOException
- if the minimum data rate, when set, is not respectedWriteFlusher.Listener
public void recycle()
public void resetBuffer()
public void setWriteListener(javax.servlet.WriteListener writeListener)
setWriteListener
in class javax.servlet.ServletOutputStream
public boolean isReady()
isReady
in class javax.servlet.ServletOutputStream
public void run()
run
in interface java.lang.Runnable
private void close(java.io.Closeable resource)
public java.lang.String toString()
toString
in class java.lang.Object