Introduction to the DpqlWebSocket Module

The DpqlWebSocket module provides WebSocket-based DPQL language services for DataProvider-aware clients. It exposes a JSON message protocol for tokenization, parsing, validation, completion, and serialization.

The module provides:

DataProvider::DpqlWebSocketHandler: WebSocket handler for HttpServer
DataProvider::DpqlWebSocketConnection: Per-client session handler

Basic Usage

%requires HttpServer
%requires DpqlWebSocket
 
DataProvider::DpqlWebSocketHandler handler();
 
HttpServer server({"port": 8080});
server.addHandler("/ws/dpql", handler);
server.start();

Clients connect to ws://localhost:8080/ws/dpql. The full message schema is defined in DpqlWebSocket/DpqlApi.asyncapi.yaml.

v1.0

initial release of DPQL WebSocket language services