Package org.eclipse.jetty.server
Class HttpOutput
- java.lang.Object
-
- java.io.OutputStream
-
- javax.servlet.ServletOutputStream
-
- org.eclipse.jetty.server.HttpOutput
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.Flushable
,java.lang.AutoCloseable
,java.lang.Runnable
public class HttpOutput extends javax.servlet.ServletOutputStream implements java.lang.Runnable
HttpOutput
implementsServletOutputStream
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 viaRequestDispatcher.include(ServletRequest, ServletResponse)
to close the stream, to be reopened after the inclusion ends.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
HttpOutput.ApiState
The API State which combines with the output State:private class
HttpOutput.AsyncFlush
private class
HttpOutput.AsyncWrite
private class
HttpOutput.ChannelWriteCB
private class
HttpOutput.InputStreamWritingCB
An iterating callback that will take content from an InputStream and write it to the associatedHttpChannel
.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 class
HttpOutput.NestedChannelWriteCB
private class
HttpOutput.ReadableByteChannelWritingCB
An iterating callback that will take content from a ReadableByteChannel and write it to theHttpChannel
.(package private) static class
HttpOutput.State
The output stateprivate static class
HttpOutput.WriteBlocker
private class
HttpOutput.WriteCompleteCB
-
Field Summary
Fields Modifier and Type Field Description private java.nio.ByteBuffer
_aggregate
private HttpOutput.ApiState
_apiState
private int
_bufferSize
private HttpChannel
_channel
private HttpChannelState
_channelState
private Callback
_closedCallback
private int
_commitSize
private static java.lang.ThreadLocal<java.nio.charset.CharsetEncoder>
_encoder
private long
_firstByteTimeStamp
private long
_flushed
private HttpOutput.Interceptor
_interceptor
private java.lang.Throwable
_onError
private boolean
_softClose
private HttpOutput.State
_state
private SharedBlockingCallback
_writeBlocker
private javax.servlet.WriteListener
_writeListener
private long
_written
private static Logger
LOG
private static java.lang.String
LSTRING_FILE
private static java.util.ResourceBundle
lStrings
-
Constructor Summary
Constructors Constructor Description HttpOutput(HttpChannel channel)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private java.nio.ByteBuffer
acquireBuffer()
protected SharedBlockingCallback.Blocker
acquireWriteBlockingCallback()
private void
channelWrite(java.nio.ByteBuffer content, boolean complete)
private void
channelWrite(java.nio.ByteBuffer content, boolean last, Callback callback)
private void
checkWritable()
void
close()
void
complete(Callback callback)
void
completed(java.lang.Throwable failure)
Called to indicate that the request cycle has been completed.void
flush()
java.nio.ByteBuffer
getBuffer()
int
getBufferSize()
HttpChannel
getHttpChannel()
HttpOutput.Interceptor
getInterceptor()
long
getWritten()
boolean
isAsync()
boolean
isClosed()
boolean
isReady()
boolean
isWritten()
private int
maximizeAggregateSpace()
void
onFlushed(long bytes)
Invoked when bytes have been flushed to the network.private void
onWriteComplete(boolean last, java.lang.Throwable failure)
private boolean
prepareSendContent(int len, Callback callback)
void
print(java.lang.String s)
private void
print(java.lang.String s, boolean eoln)
void
println(boolean b)
void
println(char c)
void
println(double d)
void
println(float f)
void
println(int i)
void
println(long l)
void
println(java.lang.String s)
void
recycle()
private void
releaseBuffer(java.lang.Throwable failure)
void
reopen()
void
resetBuffer()
void
run()
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.ByteBuffer content)
Blocking send of whole content.void
sendContent(java.nio.ByteBuffer content, Callback callback)
Asynchronous send of whole 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
sendContent(HttpContent content)
Blocking send of HTTP content.void
sendContent(HttpContent httpContent, Callback callback)
Asynchronous send of HTTP content.void
setBufferSize(int size)
void
setInterceptor(HttpOutput.Interceptor interceptor)
void
setWriteListener(javax.servlet.WriteListener writeListener)
void
softClose()
private java.lang.String
stateString()
java.lang.String
toString()
private boolean
updateApiState(java.lang.Throwable failure)
void
write(byte[] b, int off, int len)
void
write(int b)
void
write(java.nio.ByteBuffer buffer)
-
-
-
Field Detail
-
LSTRING_FILE
private static final java.lang.String LSTRING_FILE
- See Also:
- Constant Field Values
-
lStrings
private static java.util.ResourceBundle lStrings
-
LOG
private static Logger LOG
-
_encoder
private static final java.lang.ThreadLocal<java.nio.charset.CharsetEncoder> _encoder
-
_channel
private final HttpChannel _channel
-
_channelState
private final HttpChannelState _channelState
-
_writeBlocker
private final SharedBlockingCallback _writeBlocker
-
_apiState
private HttpOutput.ApiState _apiState
-
_state
private HttpOutput.State _state
-
_softClose
private boolean _softClose
-
_interceptor
private HttpOutput.Interceptor _interceptor
-
_written
private long _written
-
_flushed
private long _flushed
-
_firstByteTimeStamp
private long _firstByteTimeStamp
-
_aggregate
private java.nio.ByteBuffer _aggregate
-
_bufferSize
private int _bufferSize
-
_commitSize
private int _commitSize
-
_writeListener
private javax.servlet.WriteListener _writeListener
-
_onError
private volatile java.lang.Throwable _onError
-
_closedCallback
private Callback _closedCallback
-
-
Constructor Detail
-
HttpOutput
public HttpOutput(HttpChannel channel)
-
-
Method Detail
-
getHttpChannel
public HttpChannel getHttpChannel()
-
getInterceptor
public HttpOutput.Interceptor getInterceptor()
-
setInterceptor
public void setInterceptor(HttpOutput.Interceptor interceptor)
-
isWritten
public boolean isWritten()
-
getWritten
public long getWritten()
-
reopen
public void reopen()
-
acquireWriteBlockingCallback
protected SharedBlockingCallback.Blocker acquireWriteBlockingCallback() throws java.io.IOException
- Throws:
java.io.IOException
-
channelWrite
private void channelWrite(java.nio.ByteBuffer content, boolean complete) throws java.io.IOException
- Throws:
java.io.IOException
-
channelWrite
private void channelWrite(java.nio.ByteBuffer content, boolean last, Callback callback)
-
onWriteComplete
private void onWriteComplete(boolean last, java.lang.Throwable failure)
-
updateApiState
private boolean updateApiState(java.lang.Throwable failure)
-
maximizeAggregateSpace
private int maximizeAggregateSpace()
-
softClose
public void softClose()
-
complete
public void complete(Callback callback)
-
completed
public void completed(java.lang.Throwable failure)
Called to indicate that the request cycle has been completed.
-
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
-
getBuffer
public java.nio.ByteBuffer getBuffer()
-
acquireBuffer
private java.nio.ByteBuffer acquireBuffer()
-
releaseBuffer
private void releaseBuffer(java.lang.Throwable failure)
-
isClosed
public boolean isClosed()
-
isAsync
public boolean isAsync()
-
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
-
checkWritable
private void checkWritable() throws EofException
- Throws:
EofException
-
write
public void write(byte[] b, int off, int len) throws java.io.IOException
- Overrides:
write
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
write
public void write(java.nio.ByteBuffer buffer) throws java.io.IOException
- Throws:
java.io.IOException
-
write
public void write(int b) throws java.io.IOException
- Specified by:
write
in classjava.io.OutputStream
- Throws:
java.io.IOException
-
print
public void print(java.lang.String s) throws java.io.IOException
- Overrides:
print
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(java.lang.String s) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
print
private void print(java.lang.String s, boolean eoln) throws java.io.IOException
- Throws:
java.io.IOException
-
println
public void println(boolean b) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(char c) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(int i) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(long l) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(float f) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
println
public void println(double d) throws java.io.IOException
- Overrides:
println
in classjavax.servlet.ServletOutputStream
- Throws:
java.io.IOException
-
sendContent
public void sendContent(java.nio.ByteBuffer content) throws java.io.IOException
Blocking send of whole content.- Parameters:
content
- The whole content to send- Throws:
java.io.IOException
- if the send fails
-
sendContent
public void sendContent(java.io.InputStream in) throws java.io.IOException
Blocking send of stream content.- Parameters:
in
- The stream content to send- Throws:
java.io.IOException
- if the send fails
-
sendContent
public void sendContent(java.nio.channels.ReadableByteChannel in) throws java.io.IOException
Blocking send of channel content.- Parameters:
in
- The channel content to send- Throws:
java.io.IOException
- if the send fails
-
sendContent
public void sendContent(HttpContent content) throws java.io.IOException
Blocking send of HTTP content.- Parameters:
content
- The HTTP content to send- Throws:
java.io.IOException
- if the send fails
-
sendContent
public void sendContent(java.nio.ByteBuffer content, Callback callback)
Asynchronous send of whole content.- Parameters:
content
- The whole content to sendcallback
- The callback to use to notify success or failure
-
sendContent
public void sendContent(java.io.InputStream in, Callback callback)
Asynchronous send of stream content. The stream will be closed after reading all content.- Parameters:
in
- The stream content to sendcallback
- The callback to use to notify success or failure
-
sendContent
public void sendContent(java.nio.channels.ReadableByteChannel in, Callback callback)
Asynchronous send of channel content. The channel will be closed after reading all content.- Parameters:
in
- The channel content to sendcallback
- The callback to use to notify success or failure
-
prepareSendContent
private boolean prepareSendContent(int len, Callback callback)
-
sendContent
public void sendContent(HttpContent httpContent, Callback callback)
Asynchronous send of HTTP content.- Parameters:
httpContent
- The HTTP content to sendcallback
- The callback to use to notify success or failure
-
getBufferSize
public int getBufferSize()
-
setBufferSize
public void setBufferSize(int size)
-
onFlushed
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.- Parameters:
bytes
- the number of bytes flushed- Throws:
java.io.IOException
- if the minimum data rate, when set, is not respected- See Also:
WriteFlusher.Listener
-
recycle
public void recycle()
-
resetBuffer
public void resetBuffer()
-
setWriteListener
public void setWriteListener(javax.servlet.WriteListener writeListener)
- Specified by:
setWriteListener
in classjavax.servlet.ServletOutputStream
-
isReady
public boolean isReady()
- Specified by:
isReady
in classjavax.servlet.ServletOutputStream
-
run
public void run()
- Specified by:
run
in interfacejava.lang.Runnable
-
stateString
private java.lang.String stateString()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-