Websockets

engine-websockets exposes user-defined endpoints under /websockets/stomp/<suffix>. Two declaration styles are supported.

@Websocket annotation

A class exposing any combination of onOpen(), onMessage(String, String), onError(String), onClose().

Java:

package com.acme.demo;

import org.eclipse.dirigible.sdk.net.Websocket;
import org.eclipse.dirigible.sdk.net.WebsocketHandler;

@Websocket(name = "chat", endpoint = "chat")
public class ChatEndpoint implements WebsocketHandler {

    @Override
    public void onMessage(String message, String sessionId) {
        // route / broadcast
    }

    // onOpen / onError / onClose inherit the no-op default
}

WebsocketHandler is the optional typed contract for the four lifecycle callbacks. All methods are default no-ops, so handlers only override what they need - no empty stubs. Classes that don't implement the interface still work via the same method-by-name reflective dispatch. See /sdk/net/decorators for details.

TypeScript:

import { Websocket } from "@aerokit/sdk/net";

@Websocket({ name: "chat", endpoint: "chat" })
export class ChatEndpoint {

  public onOpen() { }
  public onMessage(message: string, sessionId: string) { }
  public onError(error: string) { }
  public onClose() { }
}

Reach the endpoint at /websockets/stomp/chat.

.websocket artefact

A JSON descriptor pointing at a JS/TS handler module:

{
  "endpoint": "chat",
  "handler": "demo/websockets/chat.js"
}

WebsocketsSynchronizer reconciles each .websocket file into a live endpoint.

Hot-reload

Both declarations are hot-reloaded - the endpoint is reinstalled on every change.

See also

• TypeScript API - net.
• Java SDK - net.