Package io.karatelabs.http

Class WsClientOptions.Builder

java.lang.Object

io.karatelabs.http.WsClientOptions.Builder

Enclosing class:

WsClientOptions

public static class WsClientOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WsClientOptions	build()
WsClientOptions.Builder	callbackExecutor(ExecutorService executor)
WsClientOptions.Builder	compression(boolean enabled)
WsClientOptions.Builder	connectTimeout(Duration timeout)
WsClientOptions.Builder	disablePing()
WsClientOptions.Builder	header(String name, String value)
WsClientOptions.Builder	headers(Map<String,String> headers)
WsClientOptions.Builder	maxPayloadSize(int size)
WsClientOptions.Builder	onClose(Runnable listener)	Register a close listener before the connection is opened (see onMessage(java.util.function.Consumer<io.karatelabs.http.WsFrame>)).
WsClientOptions.Builder	onError(Consumer<Throwable> listener)	Register an error listener before the connection is opened (see onMessage(java.util.function.Consumer<io.karatelabs.http.WsFrame>)).
WsClientOptions.Builder	onMessage(Consumer<WsFrame> listener)	Register a message listener BEFORE the connection is opened.
WsClientOptions.Builder	pingInterval(Duration interval)
WsClientOptions.Builder	sslContext(io.netty.handler.ssl.SslContext context)
WsClientOptions.Builder	subProtocol(String subProtocol)	The WebSocket subprotocol to negotiate during the handshake (Sec-WebSocket-Protocol).
WsClientOptions.Builder	trustAllCerts(boolean trust)

Methods inherited from class java.lang.Object

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

Method Details

headers

public WsClientOptions.Builder headers(Map<String,String> headers)

header

public WsClientOptions.Builder header(String name,
 String value)

subProtocol

public WsClientOptions.Builder subProtocol(String subProtocol)

The WebSocket subprotocol to negotiate during the handshake (Sec-WebSocket-Protocol).

compression

public WsClientOptions.Builder compression(boolean enabled)

maxPayloadSize

public WsClientOptions.Builder maxPayloadSize(int size)

connectTimeout

public WsClientOptions.Builder connectTimeout(Duration timeout)

pingInterval

public WsClientOptions.Builder pingInterval(Duration interval)

disablePing

public WsClientOptions.Builder disablePing()

sslContext

public WsClientOptions.Builder sslContext(io.netty.handler.ssl.SslContext context)

trustAllCerts

public WsClientOptions.Builder trustAllCerts(boolean trust)

callbackExecutor

public WsClientOptions.Builder callbackExecutor(ExecutorService executor)

onMessage

public WsClientOptions.Builder onMessage(Consumer<WsFrame> listener)

Register a message listener BEFORE the connection is opened. For server-speaks-first protocols (e.g. RFB/VNC behind websockify) a listener added after WsClient.connect(java.lang.String) returns can miss the server's opening frame.

onClose

public WsClientOptions.Builder onClose(Runnable listener)

Register a close listener before the connection is opened (see onMessage(java.util.function.Consumer<io.karatelabs.http.WsFrame>)).

onError

public WsClientOptions.Builder onError(Consumer<Throwable> listener)

Register an error listener before the connection is opened (see onMessage(java.util.function.Consumer<io.karatelabs.http.WsFrame>)).

build

public WsClientOptions build()