com.jauntsdn.netty.handler.codec.http.websocketx

Class WebSocketServerProtocolHandler.Builder

java.lang.Object

com.jauntsdn.netty.handler.codec.http.websocketx.WebSocketServerProtocolHandler.Builder

Enclosing class:

WebSocketServerProtocolHandler

public static final class WebSocketServerProtocolHandler.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
WebSocketServerProtocolHandler	build()
static WebSocketServerProtocolHandler.Builder	create()
WebSocketServerProtocolHandler.Builder	decoderConfig(WebSocketDecoderConfig decoderConfig)
WebSocketServerProtocolHandler.Builder	handshakeTimeoutMillis(long handshakeTimeoutMillis)
WebSocketServerProtocolHandler.Builder	nomaskingExtension(boolean nomaskingExtension)
WebSocketServerProtocolHandler.Builder	path(String path)
WebSocketServerProtocolHandler.Builder	subprotocols(String subprotocols)
WebSocketServerProtocolHandler.Builder	webSocketCallbacksHandler(WebSocketCallbacksHandler webSocketHandler)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WebSocketServerProtocolHandler.Builder create()

path

public WebSocketServerProtocolHandler.Builder path(String path)

Parameters:

path - websocket path starting with "/". Must be non-null

Returns:

this Builder instance

subprotocols

public WebSocketServerProtocolHandler.Builder subprotocols(@Nullable
                                                           String subprotocols)

Parameters:

subprotocols - accepted subprotocols. May be null

Returns:

this Builder instance

decoderConfig

public WebSocketServerProtocolHandler.Builder decoderConfig(WebSocketDecoderConfig decoderConfig)

Parameters:

decoderConfig - webSocket decoder config that corresponds to library declared scope: no extensions, no utf8 validation, maxFrameLength is [125, 65_635] range. Must be non-null.

Returns:

this Builder instance

nomaskingExtension

public WebSocketServerProtocolHandler.Builder nomaskingExtension(boolean nomaskingExtension)

Parameters:

nomaskingExtension - enables "no-masking" extension draft. Takes precedence over masking related configuration.

Returns:

this Builder instance

handshakeTimeoutMillis

public WebSocketServerProtocolHandler.Builder handshakeTimeoutMillis(long handshakeTimeoutMillis)

Parameters:

handshakeTimeoutMillis - webSocket handshake timeout

Returns:

this Builder instance

webSocketCallbacksHandler

public WebSocketServerProtocolHandler.Builder webSocketCallbacksHandler(@Nullable
                                                                        WebSocketCallbacksHandler webSocketHandler)

Parameters:

webSocketHandler - handler to process successfully handshaked webSocket

Returns:

this Builder instance

build

public WebSocketServerProtocolHandler build()

Returns:

new WebSocketServerProtocolHandler instance