io.fabric8.kubernetes.client.http

Interface WebSocket.Builder

All Superinterfaces:

BasicBuilder

All Known Implementing Classes:

StandardWebSocketBuilder

Enclosing interface:

WebSocket

public static interface WebSocket.Builder
extends BasicBuilder

Method Summary

Modifier and Type	Method and Description
CompletableFuture<WebSocket>	buildAsync(WebSocket.Listener listener) Builds a new WebSocket connection and waits asynchronously until the connection is opened.
WebSocket.Builder	connectTimeout(long timeout, TimeUnit timeUnit)
WebSocket.Builder	header(String name, String value) Add the key value pair.
WebSocket.Builder	setHeader(String k, String v) Set the key value pair.
WebSocket.Builder	subprotocol(String protocol) Protocol used for WebSocket message exchange.
WebSocket.Builder	uri(URI uri)

Method Detail

buildAsync

CompletableFuture<WebSocket> buildAsync(WebSocket.Listener listener)

Builds a new WebSocket connection and waits asynchronously until the connection is opened. The listener onOpen callback is called before the returned future is completed.

Parameters:

listener -

Returns:

CompletableFuture which is completed after connection is opened

subprotocol

WebSocket.Builder subprotocol(String protocol)

Protocol used for WebSocket message exchange.

The client can request that the server use a specific subprotocol by including the |Sec-WebSocket-Protocol| field in its handshake. If it is specified, the server needs to include the same field and one of the selected subprotocol values in its response for the connection to be established.

RFC 6455: Section 1.9, Subprotocols Using the WebSocket Protocol

Parameters:

protocol - the protocol to be used.

Returns:

this builder.

header

WebSocket.Builder header(String name,
                         String value)

Description copied from interface: BasicBuilder

Add the key value pair. Will append to an existing key.

Specified by:

header in interface BasicBuilder

Parameters:

name - key

value - value

Returns:

the builder

setHeader

WebSocket.Builder setHeader(String k,
                            String v)

Description copied from interface: BasicBuilder

Set the key value pair. Will overwrite an existing key.

Specified by:

setHeader in interface BasicBuilder

Parameters:

k - key

v - value

Returns:

the builder

uri

WebSocket.Builder uri(URI uri)

Specified by:

uri in interface BasicBuilder

connectTimeout

WebSocket.Builder connectTimeout(long timeout,
                                 TimeUnit timeUnit)