io.reactivex.netty.protocol.http.server

Class ResponseContentWriter<C>

java.lang.Object

rx.Observable<java.lang.Void>

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

Direct Known Subclasses:

HttpServerResponse

public abstract class ResponseContentWriter<C>
extends rx.Observable<java.lang.Void>

A facility to optionally write content to the response.

Thread safety

This object is not thread-safe and can not be accessed from multiple threads.

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
abstract ResponseContentWriter<C>	write(rx.Observable<C> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
abstract <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.
abstract <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.
abstract 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 .
abstract 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.
abstract ResponseContentWriter<C>	writeBytes(rx.Observable<byte[]> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
abstract <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.
abstract <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.
abstract 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 .
abstract 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.
abstract ResponseContentWriter<C>	writeString(rx.Observable<java.lang.String> msgs) On subscription of the returned Observable, writes the passed message stream on the underneath channel.
abstract <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.
abstract <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.
abstract 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 .
abstract 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

write

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

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.

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 abstract <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. 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.

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 abstract <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. 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.

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 abstract 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 . 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.

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 abstract 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. 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.

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 abstract ResponseContentWriter<C> writeString(rx.Observable<java.lang.String> msgs)

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.

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 abstract <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. 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.

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 abstract <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. 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.

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 abstract 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 . 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.

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 abstract 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. 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.

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 abstract ResponseContentWriter<C> writeBytes(rx.Observable<byte[]> msgs)

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.

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 abstract <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. 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.

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 abstract <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. 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.

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 abstract 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 . 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.

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 abstract 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. 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.

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.