io.reactivex.netty.protocol.http.server

Class HttpServerResponseImpl<C>

java.lang.Object

rx.Observable<java.lang.Void>

io.reactivex.netty.protocol.http.server.ResponseContentWriter<C>

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

io.reactivex.netty.protocol.http.server.HttpServerResponseImpl<C>

public final class HttpServerResponseImpl<C>
extends HttpServerResponse<C>

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

rx.Observable.OnSubscribe<T>, rx.Observable.Operator<R,T>, rx.Observable.Transformer<T,R>

Method Summary

Modifier and Type	Method and Description
WebSocketHandshaker	acceptWebSocketUpgrade(WebSocketHandler handler) Accepts the upgrade to websockets, if requested and after sending a successful handshake response, invokes the passed handler to handle the websocket connection.
HttpServerResponse<C>	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Adds the passed cookie to this response.
HttpServerResponse<C>	addDateHeader(java.lang.CharSequence name, java.util.Date value) Adds the passed header as a date value to this response.
HttpServerResponse<C>	addDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Adds multiple date values for the passed header name to this response.
HttpServerResponse<C>	addHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values) Adds an HTTP header with the passed name and values to this response.
HttpServerResponse<C>	addHeader(java.lang.CharSequence name, java.lang.Object value) Adds an HTTP header with the passed name and value to this response.
boolean	containsHeader(java.lang.CharSequence name) Checks if there is a header with the passed name in this response.
boolean	containsHeader(java.lang.CharSequence name, java.lang.CharSequence value, boolean ignoreCaseValue) Checks if there is a header with the passed name and value in this response.
static <T> HttpServerResponse<T>	create(HttpServerRequest<?> request, io.reactivex.netty.channel.Connection connection, io.netty.handler.codec.http.HttpResponse headers)
rx.Observable<java.lang.Void>	dispose() Disposes this response.
HttpServerResponse<C>	flushOnlyOnReadComplete() This is a performance optimization to not flush the channel on every response send.
java.util.List<java.lang.String>	getAllHeaderValues(java.lang.CharSequence name) Returns the values of headers with the specified name
long	getDateHeader(java.lang.CharSequence name) Returns the date header value with the specified header name.
long	getDateHeader(java.lang.CharSequence name, long defaultValue) Returns the date header value with the specified header name.
java.lang.String	getHeader(java.lang.CharSequence name) Returns the value of a header with the specified name.
java.lang.String	getHeader(java.lang.CharSequence name, java.lang.String defaultValue) Returns the value of a header with the specified name.
java.util.Set<java.lang.String>	getHeaderNames() Returns a new Set that contains the names of all headers in this response.
int	getIntHeader(java.lang.CharSequence name) Returns the integer header value with the specified header name.
int	getIntHeader(java.lang.CharSequence name, int defaultValue) Returns the integer header value with the specified header name.
io.netty.handler.codec.http.HttpResponseStatus	getStatus() Returns the status of this response.
HttpServerResponse<C>	removeHeader(java.lang.CharSequence name) Removes the passed header from this response.
ResponseContentWriter<C>	sendHeaders() Sends the headers for this response when the returned Observable is subscribed.
HttpServerResponse<C>	setDateHeader(java.lang.CharSequence name, java.util.Date value) Overwrites the current value, if any, of the passed header to the passed date value for this response.
HttpServerResponse<C>	setDateHeader(java.lang.CharSequence name, java.lang.Iterable<java.util.Date> values) Overwrites the current value, if any, of the passed header to the passed date values for this response.
HttpServerResponse<C>	setHeader(java.lang.CharSequence name, java.lang.Iterable<java.lang.Object> values) Overwrites the current value, if any, of the passed header to the passed values for this response.
HttpServerResponse<C>	setHeader(java.lang.CharSequence name, java.lang.Object value) Overwrites the current value, if any, of the passed header to the passed value for this response.
HttpServerResponse<C>	setStatus(io.netty.handler.codec.http.HttpResponseStatus status) Sets the status for the response.
HttpServerResponse<C>	setTransferEncodingChunked() Sets the HTTP transfer encoding to chunked for this response.
<CC> HttpServerResponse<CC>	transformContent(io.reactivex.netty.channel.AllocatingTransformer<CC,C> transformer) Creates a new HttpServerResponse instance modifying the content type using the passed transformer.
HttpServerResponse<ServerSentEvent>	transformToServerSentEvents() Converts this response to enable writing ServerSentEvents.
io.reactivex.netty.channel.Connection<?,?>	unsafeConnection() Returns the underlying connection on which this response was received.
io.netty.channel.Channel	unsafeNettyChannel() Returns the underlying channel on which this response was received.
ResponseContentWriter<C>	write(rx.Observable<C> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	write(rx.Observable<C> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,C,T> trailerMutator) Uses the passed Observable as the source of content for this request.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	write(rx.Observable<C> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,C,T> trailerMutator, rx.functions.Func1<C,java.lang.Boolean> flushSelector) Uses the passed Observable as the source of content for this request.
ResponseContentWriter<C>	write(rx.Observable<C> msgs, rx.functions.Func1<C,java.lang.Boolean> flushSelector) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true .
ResponseContentWriter<C>	writeAndFlushOnEach(rx.Observable<C> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write.
ResponseContentWriter<C>	writeBytes(rx.Observable<byte[]> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	writeBytes(rx.Observable<byte[]> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,byte[],T> trailerMutator) Uses the passed Observable as the source of content for this request.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	writeBytes(rx.Observable<byte[]> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,byte[],T> trailerMutator, rx.functions.Func1<byte[],java.lang.Boolean> flushSelector) Uses the passed Observable as the source of content for this request.
ResponseContentWriter<C>	writeBytes(rx.Observable<byte[]> msgs, rx.functions.Func1<byte[],java.lang.Boolean> flushSelector) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true .
ResponseContentWriter<C>	writeBytesAndFlushOnEach(rx.Observable<byte[]> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write.
ResponseContentWriter<C>	writeString(rx.Observable<java.lang.String> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	writeString(rx.Observable<java.lang.String> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,java.lang.String,T> trailerMutator) Uses the passed Observable as the source of content for this request.
<T extends TrailingHeaders> rx.Observable<java.lang.Void>	writeString(rx.Observable<java.lang.String> contentSource, rx.functions.Func0<T> trailerFactory, rx.functions.Func2<T,java.lang.String,T> trailerMutator, rx.functions.Func1<java.lang.String,java.lang.Boolean> flushSelector) Uses the passed Observable as the source of content for this request.
ResponseContentWriter<C>	writeString(rx.Observable<java.lang.String> msgs, rx.functions.Func1<java.lang.String,java.lang.Boolean> flushSelector) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true .
ResponseContentWriter<C>	writeStringAndFlushOnEach(rx.Observable<java.lang.String> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write.

Methods inherited from class rx.Observable

all, amb, amb, amb, amb, amb, amb, amb, amb, amb, ambWith, asObservable, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, cache, cache, cast, collect, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concat, concat, concat, concat, concat, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatMap, concatMapEager, concatMapEager, concatWith, contains, count, countLong, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, error, exists, extend, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, forEach, forEach, forEach, from, from, from, from, from, fromCallable, groupBy, groupBy, groupJoin, ignoreElements, interval, interval, interval, interval, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, last, lastOrDefault, lastOrDefault, lift, limit, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, nest, never, observeOn, ofType, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, publish, publish, range, range, reduce, reduce, repeat, repeat, repeat, repeat, repeatWhen, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retryWhen, retryWhen, sample, sample, sample, scan, scan, sequenceEqual, sequenceEqual, serialize, share, single, single, singleOrDefault, singleOrDefault, skip, skip, skip, skipLast, skipLast, skipLast, skipUntil, skipWhile, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, switchIfEmpty, switchMap, switchOnNext, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeUntil, takeWhile, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, toBlocking, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSingle, toSortedList, toSortedList, toSortedList, toSortedList, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Method Detail

getStatus

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

Description copied from class: HttpServerResponse

Returns the status of this response. If the status is not explicitly set, the default value is HttpResponseStatus.OK

Specified by:

getStatus in class HttpServerResponse<C>

Returns:

The status of this response.

containsHeader

public boolean containsHeader(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Checks if there is a header with the passed name in this response.

Specified by:

containsHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

Returns:

true if there is a header with the passed name in this response.

containsHeader

public boolean containsHeader(java.lang.CharSequence name,
                              java.lang.CharSequence value,
                              boolean ignoreCaseValue)

Description copied from class: HttpServerResponse

Checks if there is a header with the passed name and value in this response.

Specified by:

containsHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

value - Value of the header.

ignoreCaseValue - true then the value comparision is done ignoring case.

Returns:

true if there is a header with the passed name and value in this response.

getHeader

public java.lang.String getHeader(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Specified by:

getHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

Returns:

The first header value or null if there is no such header

getHeader

public java.lang.String getHeader(java.lang.CharSequence name,
                                  java.lang.String defaultValue)

Description copied from class: HttpServerResponse

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Specified by:

getHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

defaultValue - Default if the header does not exist.

Returns:

The first header value or defaultValue if there is no such header

getAllHeaderValues

public java.util.List<java.lang.String> getAllHeaderValues(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Returns the values of headers with the specified name

Specified by:

getAllHeaderValues in class HttpServerResponse<C>

Parameters:

name - The name of the headers to search

Returns:

A List of header values which will be empty if no values are found

getDateHeader

public long getDateHeader(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

getDateHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

Returns:

the header value

getDateHeader

public long getDateHeader(java.lang.CharSequence name,
                          long defaultValue)

Description copied from class: HttpServerResponse

Returns the date header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned. The value is parsed as per the HTTP specifications using the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

getDateHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

defaultValue - Default value if there is no header with this name.

Returns:

the header value or defaultValue if there is no header with this name.

getIntHeader

public int getIntHeader(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Specified by:

getIntHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

Returns:

the header value

getIntHeader

public int getIntHeader(java.lang.CharSequence name,
                        int defaultValue)

Description copied from class: HttpServerResponse

Returns the integer header value with the specified header name. If there are more than one header value for the specified header name, the first value is returned.

Specified by:

getIntHeader in class HttpServerResponse<C>

Parameters:

name - The name of the header to search

defaultValue - Default if the header does not exist.

Returns:

the header value or the defaultValue if there is no such header or the header value is not a number

getHeaderNames

public java.util.Set<java.lang.String> getHeaderNames()

Description copied from class: HttpServerResponse

Returns a new Set that contains the names of all headers in this response. Note that modifying the returned Set will not affect the state of this response.

Specified by:

getHeaderNames in class HttpServerResponse<C>

addHeader

public HttpServerResponse<C> addHeader(java.lang.CharSequence name,
                                       java.lang.Object value)

Description copied from class: HttpServerResponse

Adds an HTTP header with the passed name and value to this response.

Specified by:

addHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

value - Value for the header.

Returns:

this

addCookie

public HttpServerResponse<C> addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)

Description copied from class: HttpServerResponse

Adds the passed cookie to this response.

Specified by:

addCookie in class HttpServerResponse<C>

Parameters:

cookie - Cookie to add.

Returns:

this

addDateHeader

public HttpServerResponse<C> addDateHeader(java.lang.CharSequence name,
                                           java.util.Date value)

Description copied from class: HttpServerResponse

Adds the passed header as a date value to this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

addDateHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

addDateHeader

public HttpServerResponse<C> addDateHeader(java.lang.CharSequence name,
                                           java.lang.Iterable<java.util.Date> values)

Description copied from class: HttpServerResponse

Adds multiple date values for the passed header name to this response. The date values are formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

addDateHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

values - Values for the header.

Returns:

this

addHeader

public HttpServerResponse<C> addHeader(java.lang.CharSequence name,
                                       java.lang.Iterable<java.lang.Object> values)

Description copied from class: HttpServerResponse

Adds an HTTP header with the passed name and values to this response.

Specified by:

addHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

values - Values for the header.

Returns:

this

setDateHeader

public HttpServerResponse<C> setDateHeader(java.lang.CharSequence name,
                                           java.util.Date value)

Description copied from class: HttpServerResponse

Overwrites the current value, if any, of the passed header to the passed date value for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

setDateHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

setHeader

public HttpServerResponse<C> setHeader(java.lang.CharSequence name,
                                       java.lang.Object value)

Description copied from class: HttpServerResponse

Overwrites the current value, if any, of the passed header to the passed value for this response.

Specified by:

setHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

value - Value of the header.

Returns:

this

setDateHeader

public HttpServerResponse<C> setDateHeader(java.lang.CharSequence name,
                                           java.lang.Iterable<java.util.Date> values)

Description copied from class: HttpServerResponse

Overwrites the current value, if any, of the passed header to the passed date values for this response. The date is formatted using netty's HttpHeaders.addDateHeader(HttpMessage, CharSequence, Date) which formats the date as per the HTTP specifications into the format:

"E, dd MMM yyyy HH:mm:ss z"

Specified by:

setDateHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

values - Values of the header.

Returns:

this

setHeader

public HttpServerResponse<C> setHeader(java.lang.CharSequence name,
                                       java.lang.Iterable<java.lang.Object> values)

Description copied from class: HttpServerResponse

Overwrites the current value, if any, of the passed header to the passed values for this response.

Specified by:

setHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

values - Values of the header.

Returns:

this

removeHeader

public HttpServerResponse<C> removeHeader(java.lang.CharSequence name)

Description copied from class: HttpServerResponse

Removes the passed header from this response.

Specified by:

removeHeader in class HttpServerResponse<C>

Parameters:

name - Name of the header.

Returns:

this

setStatus

public HttpServerResponse<C> setStatus(io.netty.handler.codec.http.HttpResponseStatus status)

Description copied from class: HttpServerResponse

Sets the status for the response.

Specified by:

setStatus in class HttpServerResponse<C>

Parameters:

status - Status to set.

Returns:

this

setTransferEncodingChunked

public HttpServerResponse<C> setTransferEncodingChunked()

Description copied from class: HttpServerResponse

Sets the HTTP transfer encoding to chunked for this response. This delegates to HttpHeaders.setTransferEncodingChunked(HttpMessage)

Specified by:

setTransferEncodingChunked in class HttpServerResponse<C>

Returns:

this

flushOnlyOnReadComplete

public HttpServerResponse<C> flushOnlyOnReadComplete()

Description copied from class: HttpServerResponse

This is a performance optimization to not flush the channel on every response send.

When NOT to use

This can be used only when the processing for a server is not asynchronous, in which case, one would have to flush the responses written explicitly (done on completion of the Observable written). Something like this:

     resp.sendHeaders()
         .writeStringAndFlushOnEach(Observable.interval(1, TimeUnit.SECONDS))
                                              .map(aLong -> "Interval =>" + aLong)
                                   )
     

When to use

This can be used when the response is written synchronously from a RequestHandler, something like:

     response.writeString(Observable.just("Hello world");
     

When set, this will make the channel to be flushed only when all the requests available on the channel are read. Thus, making it possible to do a gathering write for all pipelined requests on a connection. This reduces the number of system calls and is helpful in "Hello World" benchmarks.

Specified by:

flushOnlyOnReadComplete in class HttpServerResponse<C>

sendHeaders

public ResponseContentWriter<C> sendHeaders()

Description copied from class: HttpServerResponse

Sends the headers for this response when the returned Observable is subscribed. Alternatively, one can continue to write contents using the returned ResponseContentWriter

Specified by:

sendHeaders in class HttpServerResponse<C>

Returns:

ResponseContentWriter which can be subscribed to only send the headers or to write payload.

transformToServerSentEvents

public HttpServerResponse<ServerSentEvent> transformToServerSentEvents()

Description copied from class: HttpServerResponse

Converts this response to enable writing ServerSentEvents.

Specified by:

transformToServerSentEvents in class HttpServerResponse<C>

Returns:

This response with writing of ServerSentEvent enabled.

transformContent

public <CC> HttpServerResponse<CC> transformContent(io.reactivex.netty.channel.AllocatingTransformer<CC,C> transformer)

Description copied from class: HttpServerResponse

Creates a new HttpServerResponse instance modifying the content type using the passed transformer.

Specified by:

transformContent in class HttpServerResponse<C>

Type Parameters:

CC - New type of the content.

Parameters:

transformer - Transformer to transform the content stream.

Returns:

A new instance of HttpServerResponse with the transformed content stream.

acceptWebSocketUpgrade

public WebSocketHandshaker acceptWebSocketUpgrade(WebSocketHandler handler)

Description copied from class: HttpServerResponse

Accepts the upgrade to websockets, if requested and after sending a successful handshake response, invokes the passed handler to handle the websocket connection. If any changes to this response are required for the handshake, they should be done before invoking this method.

Specified by:

acceptWebSocketUpgrade in class HttpServerResponse<C>

Returns:

WebSocketHandshaker for sending a handshake to the client. Subscription to the handshaker, will send the handshake.

dispose

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

Description copied from class: HttpServerResponse

Disposes this response. If the response is not yet set then this will attempt to send an error response if the connection is still open.

Specified by:

dispose in class HttpServerResponse<C>

Returns:

An Observable, subscription to which will dispose this response.

unsafeNettyChannel

public io.netty.channel.Channel unsafeNettyChannel()

Description copied from class: HttpServerResponse

Returns the underlying channel on which this response was received.

Specified by:

unsafeNettyChannel in class HttpServerResponse<C>

Returns:

The underlying channel on which this response was received.

unsafeConnection

public io.reactivex.netty.channel.Connection<?,?> unsafeConnection()

Description copied from class: HttpServerResponse

Returns the underlying connection on which this response was received.

Specified by:

unsafeConnection in class HttpServerResponse<C>

Returns:

The underlying connection on which this response was received.

write

public ResponseContentWriter<C> write(rx.Observable<C> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel.

Flush

The writes are flushed when the passed stream completes.

Specified by:

write in class ResponseContentWriter<C>

Parameters:

msgs - Stream of messages to write.

Returns:

Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.

write

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> write(rx.Observable<C> contentSource,
                                                                       rx.functions.Func0<T> trailerFactory,
                                                                       rx.functions.Func2<T,C,T> trailerMutator)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Flush

The writes are flushed when the passed stream completes.

Specified by:

write in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

Returns:

An new instance of Observable which can be subscribed to execute the request.

write

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> write(rx.Observable<C> contentSource,
                                                                       rx.functions.Func0<T> trailerFactory,
                                                                       rx.functions.Func2<T,C,T> trailerMutator,
                                                                       rx.functions.Func1<C,java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Specified by:

write in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An new instance of Observable which can be subscribed to execute the request.

write

public ResponseContentWriter<C> write(rx.Observable<C> msgs,
                                      rx.functions.Func1<C,java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true . Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

write in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, when the flushSelector returns true

writeAndFlushOnEach

public ResponseContentWriter<C> writeAndFlushOnEach(rx.Observable<C> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write. Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

writeAndFlushOnEach in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, on every write.

writeString

public ResponseContentWriter<C> writeString(rx.Observable<java.lang.String> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel.

Flush

The writes are flushed when the passed stream completes.

Specified by:

writeString in class ResponseContentWriter<C>

Parameters:

msgs - Stream of messages to write.

Returns:

Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.

writeString

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> writeString(rx.Observable<java.lang.String> contentSource,
                                                                             rx.functions.Func0<T> trailerFactory,
                                                                             rx.functions.Func2<T,java.lang.String,T> trailerMutator)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Flush

The writes are flushed when the passed stream completes.

Specified by:

writeString in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

Returns:

An new instance of Observable which can be subscribed to execute the request.

writeString

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> writeString(rx.Observable<java.lang.String> contentSource,
                                                                             rx.functions.Func0<T> trailerFactory,
                                                                             rx.functions.Func2<T,java.lang.String,T> trailerMutator,
                                                                             rx.functions.Func1<java.lang.String,java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Specified by:

writeString in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An new instance of Observable which can be subscribed to execute the request.

writeString

public ResponseContentWriter<C> writeString(rx.Observable<java.lang.String> msgs,
                                            rx.functions.Func1<java.lang.String,java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true . Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

writeString in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, when the flushSelector returns true

writeStringAndFlushOnEach

public ResponseContentWriter<C> writeStringAndFlushOnEach(rx.Observable<java.lang.String> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write. Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

writeStringAndFlushOnEach in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, on every write.

writeBytes

public ResponseContentWriter<C> writeBytes(rx.Observable<byte[]> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel.

Flush

The writes are flushed when the passed stream completes.

Specified by:

writeBytes in class ResponseContentWriter<C>

Parameters:

msgs - Stream of messages to write.

Returns:

Observable representing the result of this write. Every subscription to this Observable will replay the write on the channel.

writeBytes

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> writeBytes(rx.Observable<byte[]> contentSource,
                                                                            rx.functions.Func0<T> trailerFactory,
                                                                            rx.functions.Func2<T,byte[],T> trailerMutator)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Flush

The writes are flushed when the passed stream completes.

Specified by:

writeBytes in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

Returns:

An new instance of Observable which can be subscribed to execute the request.

writeBytes

public <T extends TrailingHeaders> rx.Observable<java.lang.Void> writeBytes(rx.Observable<byte[]> contentSource,
                                                                            rx.functions.Func0<T> trailerFactory,
                                                                            rx.functions.Func2<T,byte[],T> trailerMutator,
                                                                            rx.functions.Func1<byte[],java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

Uses the passed Observable as the source of content for this request. This method provides a way to write trailing headers. A new instance of TrailingHeaders will be created using the passed trailerFactory and the passed trailerMutator will be invoked for every item emitted from the content source, giving a chance to modify the trailing headers instance.

Multiple invocations

This method can not be invoked multiple times for the same response as on completion of the passed source, it writes the trailing headers and trailing headers can only be written once for an HTTP response. So, any subsequent invocation of this method will always emit an error when subscribed.

Specified by:

writeBytes in class ResponseContentWriter<C>

Parameters:

contentSource - Content source for the response.

trailerFactory - A factory function to create a new TrailingHeaders per subscription of the content.

trailerMutator - A function to mutate the trailing header on each item emitted from the content source.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An new instance of Observable which can be subscribed to execute the request.

writeBytes

public ResponseContentWriter<C> writeBytes(rx.Observable<byte[]> msgs,
                                           rx.functions.Func1<byte[],java.lang.Boolean> flushSelector)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, everytime, flushSelector returns true . Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

writeBytes in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

flushSelector - A Func1 which is invoked for every item emitted from msgs. Channel is flushed, iff this function returns, true.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, when the flushSelector returns true

writeBytesAndFlushOnEach

public ResponseContentWriter<C> writeBytesAndFlushOnEach(rx.Observable<byte[]> msgs)

Description copied from class: ResponseContentWriter

On subscription of the returned Observable, writes the passed message stream on the underneath channel and flushes the channel, on every write. Any writes issued before subscribing, will also be flushed. However, the returned Observable will not capture the result of those writes, i.e. if the other writes, fail and this write does not, the returned Observable will not fail.

Specified by:

writeBytesAndFlushOnEach in class ResponseContentWriter<C>

Parameters:

msgs - Message stream to write.

Returns:

An Observable representing the result of this and all writes done prior to the flush. Every subscription to this Observable will write the passed messages and flush all pending writes, on every write.

create

public static <T> HttpServerResponse<T> create(HttpServerRequest<?> request,
                                               io.reactivex.netty.channel.Connection connection,
                                               io.netty.handler.codec.http.HttpResponse headers)