io.reactivex.netty.protocol.http.server

Class HttpServerResponse<T>

java.lang.Object

io.reactivex.netty.channel.DefaultChannelWriter<T>

io.reactivex.netty.protocol.http.server.HttpServerResponse<T>

All Implemented Interfaces:

ChannelWriter<T>

public class HttpServerResponse<T>
extends DefaultChannelWriter<T>

Field Summary

Fields inherited from class io.reactivex.netty.channel.DefaultChannelWriter

closeIssued, CONNECTION_ALREADY_CLOSED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpServerResponse(io.netty.channel.Channel nettyChannel, io.netty.handler.codec.http.HttpVersion httpVersion, MetricEventsSubject<? extends ServerMetricsEvent<?>> eventsSubject)
protected	HttpServerResponse(io.netty.channel.Channel nettyChannel, MetricEventsSubject<? extends ServerMetricsEvent<?>> eventsSubject)

Method Summary

Modifier and Type	Method and Description
rx.Observable<java.lang.Void>	_close(boolean flush)
void	addCookie(io.netty.handler.codec.http.Cookie cookie)
rx.Observable<java.lang.Void>	close()
rx.Observable<java.lang.Void>	close(boolean flush) Closes this response with optionally flushing the writes.
void	flushOnlyOnChannelReadComplete(boolean flushOnlyOnReadComplete) Flush semantics of a response are as follows: Flush immediately if DefaultChannelWriter.flush() is called. Flush at the completion of Observable returned by RequestHandler.handle(HttpServerRequest, HttpServerResponse) if and only if flushOnlyOnChannelReadComplete(boolean) is set to false (default is false). Flush when ChannelHandlerContext.fireChannelReadComplete() event is fired by netty.
HttpResponseHeaders	getHeaders()
io.netty.handler.codec.http.HttpResponseStatus	getStatus()
boolean	isFlushOnlyOnReadComplete()
void	setStatus(io.netty.handler.codec.http.HttpResponseStatus status)
void	writeChunkedInput(io.netty.handler.codec.http.HttpChunkedInput httpChunkedInput)
protected void	writeHeadersIfNotWritten()
protected io.netty.channel.ChannelFuture	writeOnChannel(java.lang.Object msg)

Methods inherited from class io.reactivex.netty.channel.DefaultChannelWriter

cancelPendingWrites, flush, getAllocator, getChannel, isCloseIssued, write, write, writeAndFlush, writeAndFlush, writeBytes, writeBytes, writeBytesAndFlush, writeBytesAndFlush, writeFileRegion, writeString, writeStringAndFlush

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServerResponse

protected HttpServerResponse(io.netty.channel.Channel nettyChannel,
                             MetricEventsSubject<? extends ServerMetricsEvent<?>> eventsSubject)

HttpServerResponse

protected HttpServerResponse(io.netty.channel.Channel nettyChannel,
                             io.netty.handler.codec.http.HttpVersion httpVersion,
                             MetricEventsSubject<? extends ServerMetricsEvent<?>> eventsSubject)

Method Detail

getHeaders

public HttpResponseHeaders getHeaders()

addCookie

public void addCookie(io.netty.handler.codec.http.Cookie cookie)

setStatus

public void setStatus(io.netty.handler.codec.http.HttpResponseStatus status)

getStatus

public io.netty.handler.codec.http.HttpResponseStatus getStatus()

close

public rx.Observable<java.lang.Void> close()

Specified by:

close in interface ChannelWriter<T>

Overrides:

close in class DefaultChannelWriter<T>

close

public rx.Observable<java.lang.Void> close(boolean flush)

Closes this response with optionally flushing the writes.
Unless it is required by the usecase, it is generally more optimal to leave the decision of when to flush to the framework as that enables a gathering write on the underlying socket, which is more optimal.

Specified by:

close in interface ChannelWriter<T>

Overrides:

close in class DefaultChannelWriter<T>

Parameters:

flush - If this close should also flush the writes.

Returns:

Observable representing the close result.

_close

public rx.Observable<java.lang.Void> _close(boolean flush)

Overrides:

_close in class DefaultChannelWriter<T>

writeChunkedInput

public void writeChunkedInput(io.netty.handler.codec.http.HttpChunkedInput httpChunkedInput)

flushOnlyOnChannelReadComplete

public void flushOnlyOnChannelReadComplete(boolean flushOnlyOnReadComplete)

Flush semantics of a response are as follows:

• Flush immediately if DefaultChannelWriter.flush() is called.
• Flush at the completion of Observable returned by RequestHandler.handle(HttpServerRequest, HttpServerResponse) if and only if flushOnlyOnChannelReadComplete(boolean) is set to false (default is false).
• Flush when ChannelHandlerContext.fireChannelReadComplete() event is fired by netty. This is done unconditionally and is a no-op if there is nothing to flush.

isFlushOnlyOnReadComplete

public boolean isFlushOnlyOnReadComplete()

writeOnChannel

protected io.netty.channel.ChannelFuture writeOnChannel(java.lang.Object msg)

Overrides:

writeOnChannel in class DefaultChannelWriter<T>

writeHeadersIfNotWritten

protected void writeHeadersIfNotWritten()