Package com.kristensoft.kdc

Class WebSocketServerParameters.Builder

java.lang.Object

com.kristensoft.kdc.Parameters.Builder<T>

com.kristensoft.kdc.ServerParameters.Builder<WebSocketServerParameters.Builder>

com.kristensoft.kdc.WebSocketServerParameters.Builder

Enclosing class:

WebSocketServerParameters

public static final class WebSocketServerParameters.Builder
extends ServerParameters.Builder<WebSocketServerParameters.Builder>

Builds WebSocketServerParameters instances.

Constructor Summary

Constructors

Constructor	Description
Builder()	Creates a builder for configuring WebSocket server parameters.

Method Summary

Modifier and Type	Method	Description
WebSocketServerParameters	build()	Builds the WebSocket server parameters using the configured settings.
WebSocketServerParameters.Builder	withEndpointClass(Class<? extends WebSocketEndpoint> endpointClass)	Sets the WebSocket endpoint class.
WebSocketServerParameters.Builder	withPath(String path)	Sets the WebSocket endpoint path.

Methods inherited from class com.kristensoft.kdc.ServerParameters.Builder

withBacklog

Methods inherited from class com.kristensoft.kdc.Parameters.Builder

addWhiteListEntry, registerApi, registerApi, registerApis, withAutoStart, withBindAddress, withBindAddress, withBindAddress, withCompressed, withConnectionQueuePoolSize, withCrc, withEncryptionKey, withLatencyMode, withLatencyReportingInterval, withMaxReceivedBufferSize, withMaxSendBufferSize, withSerializationFormat, withWhiteList

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Creates a builder for configuring WebSocket server parameters.

Method Detail

withPath

public WebSocketServerParameters.Builder withPath(String path)

Sets the WebSocket endpoint path.

Parameters:

path - the WebSocket endpoint path, beginning with /

Returns:

this builder

Throws:

IllegalArgumentException - if path is null, blank, or does not begin with /

withEndpointClass

public WebSocketServerParameters.Builder withEndpointClass(Class<? extends WebSocketEndpoint> endpointClass)

Sets the WebSocket endpoint class.

Parameters:

endpointClass - the WebSocket endpoint class

Returns:

this builder

Throws:

IllegalArgumentException - if endpointClass is null

build

public WebSocketServerParameters build()

Builds the WebSocket server parameters using the configured settings.

Specified by:

build in class ServerParameters.Builder<WebSocketServerParameters.Builder>

Returns:

the configured WebSocket server parameters