Package com.kristensoft.kdc

Class WebSocketServerParameters

java.lang.Object

com.kristensoft.kdc.Parameters

com.kristensoft.kdc.ServerParameters

com.kristensoft.kdc.WebSocketServerParameters

public class WebSocketServerParameters
extends ServerParameters

Defines configuration parameters for a WebSocketServer.

WebSocket-specific configuration includes the endpoint path and endpoint class, in addition to the common server settings inherited from ServerParameters.

The default WebSocket path is /kdc, and the default endpoint class is WebSocketEndpoint.

Instances are created using the WebSocketServerParameters.Builder.

Author:

Charles B. Kozoyed

See Also:

WebSocketServer, WebSocketEndpoint, WebSocketServerParameters.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketServerParameters.Builder	Builds WebSocketServerParameters instances.

Nested classes/interfaces inherited from class com.kristensoft.kdc.Parameters

Parameters.Defaults

Method Summary

Modifier and Type	Method	Description
static WebSocketServerParameters.Builder	builder()	Creates a builder for configuring WebSocket server parameters.
Class<? extends WebSocketEndpoint>	getEndpointClass()	Returns the WebSocket endpoint class.
String	getPath()	Returns the WebSocket endpoint path.

Methods inherited from class com.kristensoft.kdc.ServerParameters

getBacklog

Methods inherited from class com.kristensoft.kdc.Parameters

getApiMap, getBindAddress, getConnectionQueuePoolSize, getEncryptionKey, getLatencyReportingInterval, getMaxReceiveBufferSize, getMaxSendBufferSize, getProtocol, getProtocolVersion, getSerializationFormat, getWhiteList, isAutoStart, isCompressed, isCrc, isLatencyModeOn

Methods inherited from class java.lang.Object

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

Method Detail

getPath

public String getPath()

Returns the WebSocket endpoint path.

Returns:

the WebSocket endpoint path

getEndpointClass

public Class<? extends WebSocketEndpoint> getEndpointClass()

Returns the WebSocket endpoint class.

Returns:

the WebSocket endpoint class

builder

public static WebSocketServerParameters.Builder builder()

Creates a builder for configuring WebSocket server parameters.

Returns:

a new WebSocket server parameters builder