wslink

wslink

Wslink allows easy, bi-directional communication between a python server and a javascript client over a websocket_. The client can make RPC calls to the server, and the server can publish messages to topics that the client can subscribe to. The server can include binary attachments in these messages, which are communicated as a binary websocket message, avoiding the overhead of encoding and decoding.

RPC and publish/subscribe

The initial users of wslink driving its development are VTK_ and ParaView_. ParaViewWeb and vtkWeb require:

• RPC - a remote procedure call that can be fired by the client and return sometime later with a response from the server, possibly an error.

• Publish/subscribe - client can subscribe to a topic provided by the server, possibly with a filter on the parts of interest. When the topic has updated results, the server publishes them to the client, without further action on the client's part.

Get the whole story

This package is just the server side of wslink. See the github repo_ for the full story - and to contribute or report issues!

Configure from environment variables

Those only apply for the Python server and launcher.

• WSLINK_LAUNCHER_GET - If set to 1 this will enable the GET endpoint for session information
• WSLINK_LAUNCHER_DELETE - If set to 1 this will enable the DELETE endpoint for killing a running session
• WSLINK_MAX_MSG_SIZE - Number of bytes for a message size (default: 4194304)
• WSLINK_HEART_BEAT - Number of seconds between heartbeats (default: 30)
• WSLINK_HTTP_HEADERS - Path to json file containing HTTP headers to be added

License

Free to use in open-source and commercial projects, under the BSD-3-Clause license.

.. _github repo: https://github.com/kitware/wslink .. _ParaView: https://www.paraview.org/ .. _VTK: http://www.vtk.org/ .. _websocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket