Top Description Constructors Methods
org.eclipse.lsp4j.websocket.jakarta

public abstract Class WebSocketEndpoint<T>

extends Endpoint
Class Inheritance
Type Parameters
<T>
remote service interface type
Imports
java.util.Collection, jakarta.websocket.Endpoint, .EndpointConfig, .Session, org.eclipse.lsp4j.jsonrpc.Launcher
WebSocket endpoint implementation that connects to a JSON-RPC service.

Constructor Summary

AccessConstructor and Description
public
WebSocketEndpoint()

Method Summary

Modifier and TypeMethod and Description
protected abstract void
configure(Launcher.Builder<T> builder)

Configure the JSON-RPC launcher.

protected void
connect(Collection<Object> localServices, T remoteProxy)

Override this in order to connect the local services to the remote service proxy.

public void
onOpen(Session session, EndpointConfig config)

Implements abstract jakarta.websocket.Endpoint.onOpen.

Developers must implement this method to be notified when a new conversation has just begun.

Inherited from jakarta.websocket.Endpoint:
onCloseonError

Constructor Detail

WebSocketEndpointback to summary
public WebSocketEndpoint()

Method Detail

configureback to summary
protected abstract void configure(Launcher.Builder<T> builder)

Configure the JSON-RPC launcher. Implementations should set at least the local service and the remote interface.

connectback to summary
protected void connect(Collection<Object> localServices, T remoteProxy)

Override this in order to connect the local services to the remote service proxy.

onOpenback to summary
public void onOpen(Session session, EndpointConfig config)

Implements abstract jakarta.websocket.Endpoint.onOpen.

Doc from jakarta.websocket.Endpoint.onOpen.

Developers must implement this method to be notified when a new conversation has just begun.

Note:

  • It is permitted to send messages from this method.
  • It is permitted to add MessageHandlers from this method. No messages will be mapped to the appropriate MessageHandler until this method has completed.
Annotations
@Override