WebSockets
Last modified: November 14, 2023
1 Introduction
The Mendix Runtime supports registering custom web socket endpoints using the javax.websocket
API.
All you need to do is to use the method Core.addWebSocketEndpoint(String path, Endpoint endpoint)
to register an instance of javax.websocket.Endpoint
to respond to web socket requests on the given path.
As with
Core#addRequestHandler
, adding a web socket end point only happens on the current cluster node. It is therefore a good practice to call it in an After Startup microflow.
Below is an example of how to register a websocket in your Mendix app.
2 Example
A simple implementation of an endpoint is shown below.
|
|
If this endpoint is registered by calling Core.addWebSocketEndpoint("/my-endpoint", new websockets.TestEndpoint());
then the following functionality is available at ws://.../my-endpoint
:
- When a connection is established, the server will send the message
socket opened
- If the client sends the message
test message
, the server responds withtest response
and closes the web socket