Package net.carcdr.yhocuspocus.spring.websocket

Class SpringWebSocketTransport

java.lang.Object

net.carcdr.yhocuspocus.spring.websocket.SpringWebSocketTransport

All Implemented Interfaces:

AutoCloseable, net.carcdr.yhocuspocus.transport.Transport

public class SpringWebSocketTransport
extends Object
implements net.carcdr.yhocuspocus.transport.Transport

Spring WebSocket transport implementation.

This class adapts a Spring WebSocketSession to the Transport interface, allowing YHocuspocus to work with Spring WebSocket connections.

Thread-safe implementation that handles:

• Binary message transmission
• Connection state tracking
• Graceful closure with WebSocket close codes
• Remote address extraction

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
SpringWebSocketTransport(org.springframework.web.socket.WebSocketSession session)	Creates a new Spring WebSocket transport from a session.

Method Summary

Modifier and Type	Method	Description
void	close(int code, String reason)
String	getConnectionId()
String	getRemoteAddress()
org.springframework.web.socket.WebSocketSession	getSession()	Gets the underlying Spring WebSocket session.
boolean	isOpen()
CompletableFuture<Void>	send(byte[] message)
void	setReceiveListener(net.carcdr.yhocuspocus.transport.ReceiveListener listener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.carcdr.yhocuspocus.transport.Transport

close

Constructor Details

SpringWebSocketTransport

public SpringWebSocketTransport(org.springframework.web.socket.WebSocketSession session)

Creates a new Spring WebSocket transport from a session.

Parameters:

session - the WebSocket session (must not be null)

Throws:

IllegalArgumentException - if session is null

Method Details

send

public CompletableFuture<Void> send(byte[] message)

Specified by:

send in interface net.carcdr.yhocuspocus.transport.Transport

getConnectionId

public String getConnectionId()

Specified by:

getConnectionId in interface net.carcdr.yhocuspocus.transport.Transport

close

public void close(int code,
 String reason)

Specified by:

close in interface net.carcdr.yhocuspocus.transport.Transport

isOpen

public boolean isOpen()

Specified by:

isOpen in interface net.carcdr.yhocuspocus.transport.Transport

getRemoteAddress

public String getRemoteAddress()

Specified by:

getRemoteAddress in interface net.carcdr.yhocuspocus.transport.Transport

setReceiveListener

public void setReceiveListener(net.carcdr.yhocuspocus.transport.ReceiveListener listener)

Specified by:

setReceiveListener in interface net.carcdr.yhocuspocus.transport.Transport

getSession

public org.springframework.web.socket.WebSocketSession getSession()

Gets the underlying Spring WebSocket session.

Returns:

the WebSocket session