Package net.carcdr.yhocuspocus.websocket

Class WebSocketServer

java.lang.Object

net.carcdr.yhocuspocus.websocket.WebSocketServer

All Implemented Interfaces:

AutoCloseable

public final class WebSocketServer
extends Object
implements AutoCloseable

WebSocket server for YHocuspocus collaborative editing.

This class provides a complete WebSocket server implementation using Jetty, configured for hosting YHocuspocus instances. It handles:

• HTTP server setup and lifecycle
• WebSocket upgrade and routing
• Connection management
• Graceful shutdown

Example usage:

 YHocuspocus hocuspocus = YHocuspocus.builder()
     .extension(new InMemoryDatabaseExtension())
     .build();

 WebSocketServer server = WebSocketServer.builder()
     .server(hocuspocus)
     .port(1234)
     .path("/collaboration")
     .build();

 server.start();
 

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketServer.Builder	Builder for WebSocketServer.

Method Summary

Modifier and Type	Method	Description
static WebSocketServer.Builder	builder()	Creates a new builder for WebSocketServer.
void	close()
net.carcdr.yhocuspocus.core.YHocuspocus	getHocuspocus()	Gets the YHocuspocus server instance.
String	getPath()	Gets the WebSocket path.
int	getPort()	Gets the port the server is listening on.
boolean	isStarted()	Checks if the server is currently running.
void	start()	Starts the WebSocket server.
void	stop()	Stops the WebSocket server gracefully.

Methods inherited from class java.lang.Object

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

Method Details

start

public void start()
           throws Exception

Starts the WebSocket server.

This method blocks until the server is fully started and ready to accept connections.

Throws:

Exception - if the server fails to start

IllegalStateException - if the server is already started

stop

public void stop()
          throws Exception

Stops the WebSocket server gracefully.

This method:

1. Stops accepting new connections
2. Closes all existing WebSocket connections
3. Shuts down the HTTP server

Throws:

Exception - if the server fails to stop cleanly

isStarted

public boolean isStarted()

Checks if the server is currently running.

Returns:

true if started, false otherwise

getPort

public int getPort()

Gets the port the server is listening on.

If the server was configured with port 0 (random port), this method returns the actual port assigned by the OS after the server starts.

Returns:

port number (actual listening port if started, configured port otherwise)

getPath

public String getPath()

Gets the WebSocket path.

Returns:

path (e.g., "/collaboration")

getHocuspocus

public net.carcdr.yhocuspocus.core.YHocuspocus getHocuspocus()

Gets the YHocuspocus server instance.

Returns:

the hocuspocus server

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

builder

public static WebSocketServer.Builder builder()

Creates a new builder for WebSocketServer.

Returns:

builder instance