Package net.carcdr.yhocuspocus.websocket

Class WebSocketServer.Builder

java.lang.Object

net.carcdr.yhocuspocus.websocket.WebSocketServer.Builder

Enclosing class:

WebSocketServer

public static class WebSocketServer.Builder
extends Object

Builder for WebSocketServer.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketServer	build()	Builds the WebSocketServer instance.
WebSocketServer.Builder	host(String host)	Sets the host/interface to bind to.
WebSocketServer.Builder	path(String path)	Sets the WebSocket path.
WebSocketServer.Builder	pingInterval(Duration pingInterval)	Sets the WebSocket ping interval for keepalive.
WebSocketServer.Builder	port(int port)	Sets the port to listen on.
WebSocketServer.Builder	server(net.carcdr.yhocuspocus.core.YHocuspocus hocuspocus)	Sets the YHocuspocus server instance.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

server

public WebSocketServer.Builder server(net.carcdr.yhocuspocus.core.YHocuspocus hocuspocus)

Sets the YHocuspocus server instance.

Parameters:

hocuspocus - the server (required)

Returns:

this builder

port

public WebSocketServer.Builder port(int port)

Sets the port to listen on.

Parameters:

port - port number (0 = random port, default: 1234)

Returns:

this builder

host

public WebSocketServer.Builder host(String host)

Sets the host/interface to bind to.

Parameters:

host - hostname or IP (null = all interfaces)

Returns:

this builder

path

public WebSocketServer.Builder path(String path)

Sets the WebSocket path.

Parameters:

path - the path (default: "/")

Returns:

this builder

pingInterval

public WebSocketServer.Builder pingInterval(Duration pingInterval)

Sets the WebSocket ping interval for keepalive.

The server will automatically send WebSocket ping frames at this interval to detect broken connections. Set to Duration.ZERO to disable automatic pings.

Parameters:

pingInterval - the ping interval (default: 30 seconds)

Returns:

this builder

build

public WebSocketServer build()

Builds the WebSocketServer instance.

Returns:

new WebSocketServer

Throws:

IllegalStateException - if required fields are missing