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

Class WebSocketClientProtocolHandler.Builder

java.lang.Object

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

Enclosing class:

WebSocketClientProtocolHandler

public static final class WebSocketClientProtocolHandler.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
WebSocketClientProtocolHandler.Builder	address(String address)
WebSocketClientProtocolHandler.Builder	allowMaskMismatch(boolean allowMaskMismatch)
WebSocketClientProtocolHandler	build()
static WebSocketClientProtocolHandler.Builder	create()
WebSocketClientProtocolHandler.Builder	handshakeTimeoutMillis(long handshakeTimeoutMillis)
WebSocketClientProtocolHandler.Builder	headers(HttpHeaders headers)
WebSocketClientProtocolHandler.Builder	mask(boolean mask)
WebSocketClientProtocolHandler.Builder	mask(IntSupplier externalMask)
WebSocketClientProtocolHandler.Builder	maxFramePayloadLength(int maxFramePayloadLength)
WebSocketClientProtocolHandler.Builder	nomaskingExtension(boolean nomaskingExtension)
WebSocketClientProtocolHandler.Builder	path(String path)
WebSocketClientProtocolHandler.Builder	subprotocol(String subprotocol)
WebSocketClientProtocolHandler.Builder	webSocketHandler(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 WebSocketClientProtocolHandler.Builder create()

address

public WebSocketClientProtocolHandler.Builder address(String address)

Parameters:

address - webSocketUri address. Must be non-null

Returns:

this Builder instance

path

public WebSocketClientProtocolHandler.Builder path(String path)

Parameters:

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

Returns:

this Builder instance

subprotocol

public WebSocketClientProtocolHandler.Builder subprotocol(@Nullable
                                                          String subprotocol)

Parameters:

subprotocol - webSocket subprotocol. May be null

Returns:

this Builder instance

headers

public WebSocketClientProtocolHandler.Builder headers(@Nullable
                                                      HttpHeaders headers)

Parameters:

headers - webSocket handshake request headers

Returns:

this Builder instance

mask

public WebSocketClientProtocolHandler.Builder mask(boolean mask)

Parameters:

mask - true if frames payload must be masked, false otherwise

Returns:

this Builder instance

mask

public WebSocketClientProtocolHandler.Builder mask(@Nullable
                                                   IntSupplier externalMask)

Parameters:

externalMask - generator for payload masking key. May be null.

Returns:

this Builder instance

allowMaskMismatch

public WebSocketClientProtocolHandler.Builder allowMaskMismatch(boolean allowMaskMismatch)

Parameters:

allowMaskMismatch - true if inbound frames mask mismatch is allowed, false otherwise.

Returns:

this Builder instance

nomaskingExtension

public WebSocketClientProtocolHandler.Builder nomaskingExtension(boolean nomaskingExtension)

Parameters:

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

Returns:

this Builder instance

maxFramePayloadLength

public WebSocketClientProtocolHandler.Builder maxFramePayloadLength(int maxFramePayloadLength)

Parameters:

maxFramePayloadLength - inbound frame payload max length, must be less than or equal 65_535

Returns:

this Builder instance

handshakeTimeoutMillis

public WebSocketClientProtocolHandler.Builder handshakeTimeoutMillis(long handshakeTimeoutMillis)

Parameters:

handshakeTimeoutMillis - webSocket handshake request timeout

Returns:

this Builder instance

webSocketHandler

public WebSocketClientProtocolHandler.Builder webSocketHandler(@Nullable
                                                               WebSocketCallbacksHandler webSocketHandler)

Parameters:

webSocketHandler - handler to process successfully handshaked webSocket

Returns:

this Builder instance

build

public WebSocketClientProtocolHandler build()

Returns:

new WebSocketClientProtocolHandler instance