io.reactivex.netty.protocol.http.ws.server

Class WebSocketHandshaker

java.lang.Object

rx.Observable<java.lang.Void>

io.reactivex.netty.protocol.http.ws.server.WebSocketHandshaker

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

The websocket handshaker for sending handshake response back to the client. The defaults chosen by the handshaker can be altered by using the various methods here.

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>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_EXTENSIONS
static int	DEFAULT_MAX_FRAME_PAYLOAD_LENGTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketHandshaker(rx.Observable.OnSubscribe<java.lang.Void> f)

Method Summary

Modifier and Type	Method and Description
abstract WebSocketHandshaker	allowExtensions(boolean allowExtensions)
static boolean	isUpgradeRequested(io.netty.handler.codec.http.HttpRequest upgradeRequest)
static boolean	isUpgradeRequested(HttpServerRequest<?> upgradeRequest)
abstract WebSocketHandshaker	location(java.lang.String webSocketLocation)
abstract WebSocketHandshaker	maxFramePayloadLength(int maxFramePayloadLength)
static WebSocketHandshaker	newErrorHandshaker(java.lang.Throwable error)
static WebSocketHandshaker	newHandshaker(HttpServerRequest<?> request, HttpServerResponse<?> upgradeResponse, WebSocketHandler handler)
protected static java.lang.String	selectSubprotocol(java.lang.String requestedSubprotocols, java.lang.String[] supportedSubProtocols) This is copied from WebSocketServerHandshaker Selects the first matching supported sub protocol
abstract WebSocketHandshaker	subprotocol(java.lang.String... subprotocols)

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

Field Detail

DEFAULT_MAX_FRAME_PAYLOAD_LENGTH

public static final int DEFAULT_MAX_FRAME_PAYLOAD_LENGTH

See Also:

Constant Field Values

DEFAULT_ALLOW_EXTENSIONS

public static final boolean DEFAULT_ALLOW_EXTENSIONS

See Also:

Constant Field Values

Constructor Detail

WebSocketHandshaker

protected WebSocketHandshaker(rx.Observable.OnSubscribe<java.lang.Void> f)

Method Detail

subprotocol

public abstract WebSocketHandshaker subprotocol(java.lang.String... subprotocols)

allowExtensions

public abstract WebSocketHandshaker allowExtensions(boolean allowExtensions)

location

public abstract WebSocketHandshaker location(java.lang.String webSocketLocation)

maxFramePayloadLength

public abstract WebSocketHandshaker maxFramePayloadLength(int maxFramePayloadLength)

newHandshaker

public static WebSocketHandshaker newHandshaker(HttpServerRequest<?> request,
                                                HttpServerResponse<?> upgradeResponse,
                                                WebSocketHandler handler)

newErrorHandshaker

public static WebSocketHandshaker newErrorHandshaker(java.lang.Throwable error)

selectSubprotocol

protected static java.lang.String selectSubprotocol(java.lang.String requestedSubprotocols,
                                                    java.lang.String[] supportedSubProtocols)

This is copied from WebSocketServerHandshaker Selects the first matching supported sub protocol

Parameters:

requestedSubprotocols - CSV of protocols to be supported. e.g. "chat, superchat"

Returns:

First matching supported sub protocol. Null if not found.

isUpgradeRequested

public static boolean isUpgradeRequested(HttpServerRequest<?> upgradeRequest)

isUpgradeRequested

public static boolean isUpgradeRequested(io.netty.handler.codec.http.HttpRequest upgradeRequest)