程序包 cn.taketoday.http.server.reactive

类 ServletServerHttpResponse

java.lang.Object

cn.taketoday.http.server.reactive.AbstractServerHttpResponse

cn.taketoday.http.server.reactive.AbstractListenerServerHttpResponse

cn.taketoday.http.server.reactive.ServletServerHttpResponse

所有已实现的接口:

HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse

直接已知子类:

JettyHttpHandlerAdapter.Jetty12ServerHttpResponse, TomcatHttpHandlerAdapter.TomcatServerHttpResponse

class ServletServerHttpResponse
extends AbstractListenerServerHttpResponse

Adapt ServerHttpResponse to the Servlet HttpServletResponse.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev

嵌套类概要

嵌套类

修饰符和类型	类	说明
private final class	ServletServerHttpResponse.ResponseAsyncListener
private class	ServletServerHttpResponse.ResponseBodyFlushProcessor
private class	ServletServerHttpResponse.ResponseBodyProcessor
private class	ServletServerHttpResponse.ResponseBodyWriteListener

字段概要

字段

修饰符和类型	字段	说明
private final ServletServerHttpResponse.ResponseAsyncListener	asyncListener
private ServletServerHttpResponse.ResponseBodyFlushProcessor	bodyFlushProcessor
private ServletServerHttpResponse.ResponseBodyProcessor	bodyProcessor
private final int	bufferSize
private boolean	flushOnNext
private final ServletOutputStream	outputStream
private final ServletServerHttpRequest	request
private final HttpServletResponse	response

构造器概要

构造器

构造器	说明
ServletServerHttpResponse(HttpHeaders headers, HttpServletResponse response, AsyncContext asyncContext, cn.taketoday.core.io.buffer.DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request)
ServletServerHttpResponse(HttpServletResponse response, AsyncContext asyncContext, cn.taketoday.core.io.buffer.DataBufferFactory bufferFactory, int bufferSize, ServletServerHttpRequest request)

方法概要

修饰符和类型	方法	说明
protected void	applyCookies()	Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response.
protected void	applyHeaders()	Invoked when the response is getting committed allowing sub-classes to make apply header values to the underlying response.
protected void	applyStatusCode()	Write the status code to the underlying response.
protected org.reactivestreams.Processor<? super org.reactivestreams.Publisher<? extends cn.taketoday.core.io.buffer.DataBuffer>,Void>	createBodyFlushProcessor()	Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output.
private void	flush()
(专用程序包) AsyncListener	getAsyncListener()	Return an ServletServerHttpResponse.ResponseAsyncListener that notifies the response body Publisher and Subscriber of Servlet container events.
<T> T	getNativeResponse()	Return the underlying server response.
protected final ServletOutputStream	getOutputStream()	Return the ServletOutputStream for the current response.
Integer	getRawStatusCode()	Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.
HttpStatusCode	getStatusCode()	Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server.
private boolean	isWritePossible()
protected int	writeToOutputStream(cn.taketoday.core.io.buffer.DataBuffer dataBuffer)	Write the DataBuffer to the response body OutputStream.

从类继承的方法 cn.taketoday.http.server.reactive.AbstractListenerServerHttpResponse

writeAndFlushWithInternal, writeWithInternal

从类继承的方法 cn.taketoday.http.server.reactive.AbstractServerHttpResponse

addCookie, beforeCommit, bufferFactory, doCommit, doCommit, getCookies, getHeaders, isCommitted, setComplete, setRawStatusCode, setStatusCode, touchDataBuffer, writeAndFlushWith, writeWith

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

bufferSize

private final int bufferSize

flushOnNext

private volatile boolean flushOnNext

response

private final HttpServletResponse response

outputStream

private final ServletOutputStream outputStream

request

private final ServletServerHttpRequest request

asyncListener

private final ServletServerHttpResponse.ResponseAsyncListener asyncListener

bodyProcessor

@Nullable
private volatile ServletServerHttpResponse.ResponseBodyProcessor bodyProcessor

bodyFlushProcessor

@Nullable
private volatile ServletServerHttpResponse.ResponseBodyFlushProcessor bodyFlushProcessor

构造器详细资料

ServletServerHttpResponse

public ServletServerHttpResponse(HttpServletResponse response,
 AsyncContext asyncContext,
 cn.taketoday.core.io.buffer.DataBufferFactory bufferFactory,
 int bufferSize,
 ServletServerHttpRequest request)
                          throws IOException

抛出:

IOException

ServletServerHttpResponse

public ServletServerHttpResponse(HttpHeaders headers,
 HttpServletResponse response,
 AsyncContext asyncContext,
 cn.taketoday.core.io.buffer.DataBufferFactory bufferFactory,
 int bufferSize,
 ServletServerHttpRequest request)
                          throws IOException

抛出:

IOException

方法详细资料

getNativeResponse

public <T> T getNativeResponse()

从类复制的说明: AbstractServerHttpResponse

Return the underlying server response.

指定者:

getNativeResponse 在类中 AbstractServerHttpResponse

getStatusCode

public HttpStatusCode getStatusCode()

从接口复制的说明: ServerHttpResponse

Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be null if the status code value is outside the HttpStatus enum range, or if there is no default value from the underlying server.

指定者:

getStatusCode 在接口中 ServerHttpResponse

覆盖:

getStatusCode 在类中 AbstractServerHttpResponse

getRawStatusCode

public Integer getRawStatusCode()

从接口复制的说明: ServerHttpResponse

Return the status code that has been set, or otherwise fall back on the status of the response from the underlying server. The return value may be null if there is no default value from the underlying server.

指定者:

getRawStatusCode 在接口中 ServerHttpResponse

覆盖:

getRawStatusCode 在类中 AbstractServerHttpResponse

applyStatusCode

protected void applyStatusCode()

从类复制的说明: AbstractServerHttpResponse

Write the status code to the underlying response. This method is called once only.

指定者:

applyStatusCode 在类中 AbstractServerHttpResponse

applyHeaders

protected void applyHeaders()

从类复制的说明: AbstractServerHttpResponse

Invoked when the response is getting committed allowing sub-classes to make apply header values to the underlying response.

Note that most sub-classes use an HttpHeaders instance that wraps an adapter to the native response headers such that changes are propagated to the underlying response on the go. That means this callback is typically not used other than for specialized updates such as setting the contentType or characterEncoding fields in a Servlet response.

指定者:

applyHeaders 在类中 AbstractServerHttpResponse

applyCookies

protected void applyCookies()

从类复制的说明: AbstractServerHttpResponse

Add cookies from AbstractServerHttpResponse.getHeaders() to the underlying response. This method is called once only.

指定者:

applyCookies 在类中 AbstractServerHttpResponse

getAsyncListener

AsyncListener getAsyncListener()

Return an ServletServerHttpResponse.ResponseAsyncListener that notifies the response body Publisher and Subscriber of Servlet container events. The listener is not actually registered but is rather exposed for ServletHttpHandlerAdapter to ensure events are delegated.

createBodyFlushProcessor

protected org.reactivestreams.Processor<? super org.reactivestreams.Publisher<? extends cn.taketoday.core.io.buffer.DataBuffer>,Void> createBodyFlushProcessor()

从类复制的说明: AbstractListenerServerHttpResponse

Abstract template method to create a Processor<Publisher<DataBuffer>, Void> that will write the response body with flushes to the underlying output. Called from AbstractListenerServerHttpResponse.writeAndFlushWithInternal(Publisher).

指定者:

createBodyFlushProcessor 在类中 AbstractListenerServerHttpResponse

getOutputStream

protected final ServletOutputStream getOutputStream()

Return the ServletOutputStream for the current response.

writeToOutputStream

protected int writeToOutputStream(cn.taketoday.core.io.buffer.DataBuffer dataBuffer)
                           throws IOException

Write the DataBuffer to the response body OutputStream. Invoked only when ServletOutputStream.isReady() returns "true" and the readable bytes in the DataBuffer is greater than 0.

返回:

the number of bytes written

抛出:

IOException

flush

private void flush()
            throws IOException

抛出:

IOException

isWritePossible

private boolean isWritePossible()