rocks.xmpp.websocket.net.client

Class WebSocketConnectionConfiguration.Builder

java.lang.Object

rocks.xmpp.core.net.client.ClientConnectionConfiguration.Builder<WebSocketConnectionConfiguration.Builder>

rocks.xmpp.websocket.net.client.WebSocketConnectionConfiguration.Builder

Enclosing class:

WebSocketConnectionConfiguration

public static final class WebSocketConnectionConfiguration.Builder
extends ClientConnectionConfiguration.Builder<WebSocketConnectionConfiguration.Builder>

A builder to create a WebSocketConnectionConfiguration instance.

Method Summary

Modifier and Type	Method and Description
WebSocketConnectionConfiguration	build() Builds the connection configuration.
WebSocketConnectionConfiguration.Builder	path(java.lang.String path) Sets the path on the host, e.g.
WebSocketConnectionConfiguration.Builder	pingInterval(java.time.Duration pingInterval) Sets the ping interval.

Methods inherited from class rocks.xmpp.core.net.client.ClientConnectionConfiguration.Builder

channelEncryption, compressionMethods, connectTimeout, hostname, hostnameVerifier, port, proxy, secure, sslContext

Methods inherited from class java.lang.Object

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

Method Detail

path

public final WebSocketConnectionConfiguration.Builder path(java.lang.String path)

Sets the path on the host, e.g. “/ws/”

Parameters:

path - The path on the host.

Returns:

The builder.

pingInterval

public final WebSocketConnectionConfiguration.Builder pingInterval(java.time.Duration pingInterval)

Sets the ping interval. If not null and non-negative, a WebSocket ping is sent periodically to the server. If no pong is received within the configured response timeout (XmppSessionConfiguration.Builder.defaultResponseTimeout(Duration)) the XMPP session is closed with an exception.

Parameters:

pingInterval - The ping interval.

Returns:

The builder.

See Also:

5.5.2. Ping

build

public final WebSocketConnectionConfiguration build()

Description copied from class: ClientConnectionConfiguration.Builder

Builds the connection configuration.

Specified by:

build in class ClientConnectionConfiguration.Builder<WebSocketConnectionConfiguration.Builder>

Returns:

The concrete connection configuration.