Package net.carcdr.yhocuspocus.core

Class ClientConnection

java.lang.Object

net.carcdr.yhocuspocus.core.ClientConnection

All Implemented Interfaces:

AutoCloseable, ReceiveListener

public class ClientConnection
extends Object
implements ReceiveListener, AutoCloseable

Manages a client transport connection.

Handles authentication, message routing, and document multiplexing over a single transport connection. Transport-agnostic design allows use with WebSocket, HTTP, or other protocols.

Key responsibilities:

• Authentication flow per document
• Message queueing during authentication
• Document multiplexing (multiple documents per connection)
• Clean shutdown and resource cleanup

Note: Keepalive/ping mechanisms are handled by the transport layer (e.g., WebSocket ping/pong) to maintain transport-agnostic design.

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(int code, String reason)	Closes this connection.
String	getConnectionId()	Gets the connection ID.
Map<String,Object>	getContext()	Gets the connection context.
Transport	getTransport()	Gets the transport.
void	onMessage(byte[] data)	Called by the transport when a binary message is received.
void	send(byte[] message)	Sends a message via transport.

Methods inherited from class java.lang.Object

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

Method Details

onMessage

public void onMessage(byte[] data)

Called by the transport when a binary message is received.

Implements ReceiveListener.onMessage(byte[]).

Specified by:

onMessage in interface ReceiveListener

Parameters:

data - the raw message data

send

public void send(byte[] message)

Sends a message via transport.

Parameters:

message - the message bytes

close

public void close(int code,
 String reason)

Closes this connection.

Parameters:

code - close code

reason - close reason

close

public void close()

Specified by:

close in interface AutoCloseable

getConnectionId

public String getConnectionId()

Gets the connection ID.

Returns:

connection ID

getContext

public Map<String,Object> getContext()

Gets the connection context.

The context is mutable during the setup phase (onConnect and onAuthenticate hooks). After authentication completes, the context becomes read-only and attempts to modify it will throw UnsupportedOperationException.

Returns:

context map (mutable during setup, read-only after)

getTransport

public Transport getTransport()

Gets the transport.

Returns:

transport instance