reactor.io.net.http

Class HttpChannel<IN,OUT>

java.lang.Object

reactor.rx.Stream<IN>

reactor.io.net.ChannelStream<IN,OUT>

reactor.io.net.http.HttpChannel<IN,OUT>

All Implemented Interfaces:

org.reactivestreams.Publisher<IN>, reactor.core.support.NonBlocking, ReactorChannel<IN,OUT>

Direct Known Subclasses:

NettyHttpChannel

public abstract class HttpChannel<IN,OUT>
extends ChannelStream<IN,OUT>

A Request/Response ChannelStream extension that provides for several helpers to control HTTP behavior and observe its metadata.

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.io.net.ReactorChannel

ReactorChannel.ConsumerSpec

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<HttpChannel>	HEADERS_SENT
static java.lang.String	HTTP_SCHEME
static java.lang.String	HTTPS_SCHEME
static java.lang.String	WS_SCHEME
static java.lang.String	WSS_SCHEME

Fields inherited from class reactor.io.net.ChannelStream

log

Constructor Summary

Constructors

Constructor and Description
HttpChannel(reactor.Environment env, long prefetch, reactor.core.Dispatcher eventsDispatcher)

Method Summary

Modifier and Type	Method and Description
HttpChannel<IN,OUT>	addHeader(java.lang.String name, java.lang.String value) Accumulate a Request Header using the given name and value, appending ";" for each new value
HttpChannel<IN,OUT>	addResponseHeader(java.lang.String name, java.lang.String value) Accumulate a response HTTP header for the given key name, appending ";" for each new value
protected abstract void	doAddHeader(java.lang.String name, java.lang.String value)
protected abstract void	doAddResponseHeader(java.lang.String name, java.lang.String value)
protected abstract void	doHeader(java.lang.String name, java.lang.String value)
protected abstract void	doResponseHeader(java.lang.String name, java.lang.String value)
protected abstract void	doResponseStatus(Status status)
HttpChannel<IN,OUT>	header(java.lang.String name, java.lang.String value) Register an HTTP request header
abstract HttpHeaders	headers()
abstract boolean	isKeepAlive() Is the request keepAlive
abstract HttpChannel<IN,OUT>	keepAlive(boolean keepAlive) set the request keepAlive if true otherwise remove the existing connection keep alive header
abstract Method	method()
java.lang.String	param(java.lang.String key) Read URI param from the given key
java.util.Map<java.lang.String,java.lang.String>	params() Read all URI params
abstract Protocol	protocol()
HttpChannel<IN,OUT>	responseHeader(java.lang.String name, java.lang.String value) Define the response HTTP header for the given key
abstract ResponseHeaders	responseHeaders()
abstract Status	responseStatus()
HttpChannel<IN,OUT>	responseStatus(Status status) Set the response status to an outgoing response
HttpChannel<IN,OUT>	sse()
abstract Transfer	transfer()
abstract HttpChannel<IN,OUT>	transfer(Transfer transfer) Define the Transfer mode for this http connection
abstract java.lang.String	uri()

Methods inherited from class reactor.io.net.ChannelStream

decode, delegate, doDecoded, doSubscribeWriter, getCapacity, getDecoder, getDispatcher, getEncoder, getEnvironment, writeBufferWith, writeWith

Methods inherited from class reactor.rx.Stream

adaptiveConsume, adaptiveConsumeOn, after, batchConsume, batchConsumeOn, broadcast, broadcastOn, broadcastTo, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, cache, cancelSubscription, capacity, cast, combine, concatMap, concatWith, consume, consume, consume, consume, consume, consumeLater, consumeOn, consumeOn, consumeOn, count, count, defaultIfEmpty, dematerialize, dispatchOn, dispatchOn, dispatchOn, distinct, distinct, distinctUntilChanged, distinctUntilChanged, downstreamSubscription, elapsed, elementAt, elementAtOrDefault, env, exists, fanIn, filter, filter, finallyDo, flatMap, getTimer, groupBy, ignoreError, ignoreError, isReactivePull, join, joinWith, keepAlive, last, lift, log, log, map, materialize, merge, mergeWith, nest, next, observe, observeCancel, observeComplete, observeError, observeStart, observeSubscribe, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onErrorReturn, onOverflowBuffer, onOverflowBuffer, onOverflowDrop, partition, partition, process, recover, reduce, reduce, repeat, repeat, repeatWhen, requestWhen, retry, retry, retry, retry, retryWhen, sample, sample, sample, sample, sample, sample, sampleFirst, sampleFirst, sampleFirst, sampleFirst, sampleFirst, sampleFirst, scan, scan, skip, skip, skip, skipWhile, skipWhile, sort, sort, sort, sort, split, split, startWith, startWith, startWith, subscribe, subscribeOn, subscribeOn, subscribeOn, switchMap, take, take, take, takeWhile, tap, throttle, throttle, timeout, timeout, timeout, timeout, timestamp, toBlockingQueue, toBlockingQueue, toList, toList, toString, when, window, window, window, window, window, window, window, window, window, window, window, zip, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.io.net.ReactorChannel

on, remoteAddress

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Field Detail

WS_SCHEME

public static final java.lang.String WS_SCHEME

See Also:

Constant Field Values

WSS_SCHEME

public static final java.lang.String WSS_SCHEME

See Also:

Constant Field Values

HTTP_SCHEME

public static final java.lang.String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

public static final java.lang.String HTTPS_SCHEME

See Also:

Constant Field Values

HEADERS_SENT

protected static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<HttpChannel> HEADERS_SENT

Constructor Detail

HttpChannel

public HttpChannel(reactor.Environment env,
                   long prefetch,
                   reactor.core.Dispatcher eventsDispatcher)

Method Detail

params

public final java.util.Map<java.lang.String,java.lang.String> params()

Read all URI params

Returns:

a map of resolved parameters against their matching key name

param

public final java.lang.String param(java.lang.String key)

Read URI param from the given key

Parameters:

key - matching key

Returns:

the resolved parameter for the given key name

headers

public abstract HttpHeaders headers()

Returns:

Resolved HTTP request headers

header

public final HttpChannel<IN,OUT> header(java.lang.String name,
                                        java.lang.String value)

Register an HTTP request header

Parameters:

name - Header name

value - Header content

Returns:

this

isKeepAlive

public abstract boolean isKeepAlive()

Is the request keepAlive

Returns:

is keep alive

keepAlive

public abstract HttpChannel<IN,OUT> keepAlive(boolean keepAlive)

set the request keepAlive if true otherwise remove the existing connection keep alive header

Returns:

is keep alive

doHeader

protected abstract void doHeader(java.lang.String name,
                                 java.lang.String value)

addHeader

public HttpChannel<IN,OUT> addHeader(java.lang.String name,
                                     java.lang.String value)

Accumulate a Request Header using the given name and value, appending ";" for each new value

Parameters:

name -

value -

Returns:

this

doAddHeader

protected abstract void doAddHeader(java.lang.String name,
                                    java.lang.String value)

protocol

public abstract Protocol protocol()

Returns:

the resolved request protocol (HTTP 1.1 etc)

uri

public abstract java.lang.String uri()

Returns:

the resolved target address

method

public abstract Method method()

Returns:

the resolved request method (HTTP 1.1 etc)

responseStatus

public abstract Status responseStatus()

Returns:

the resolved HTTP Response Status

responseStatus

public HttpChannel<IN,OUT> responseStatus(Status status)

Set the response status to an outgoing response

Parameters:

status - the status to define

Returns:

this

doResponseStatus

protected abstract void doResponseStatus(Status status)

responseHeaders

public abstract ResponseHeaders responseHeaders()

Returns:

the resolved response HTTP headers

responseHeader

public final HttpChannel<IN,OUT> responseHeader(java.lang.String name,
                                                java.lang.String value)

Define the response HTTP header for the given key

Parameters:

name - the HTTP response header key to override

value - the HTTP response header content

Returns:

this

doResponseHeader

protected abstract void doResponseHeader(java.lang.String name,
                                         java.lang.String value)

addResponseHeader

public HttpChannel<IN,OUT> addResponseHeader(java.lang.String name,
                                             java.lang.String value)

Accumulate a response HTTP header for the given key name, appending ";" for each new value

Parameters:

name - the HTTP response header name

value - the HTTP response header value

Returns:

this

doAddResponseHeader

protected abstract void doAddResponseHeader(java.lang.String name,
                                            java.lang.String value)

sse

public HttpChannel<IN,OUT> sse()

Returns:

the Transfer setting SSE for this http connection (e.g. event-stream)

transfer

public abstract Transfer transfer()

Returns:

the Transfer setting for this http connection (e.g. event-stream)

transfer

public abstract HttpChannel<IN,OUT> transfer(Transfer transfer)

Define the Transfer mode for this http connection

Parameters:

transfer - the new transfer mode

Returns:

this