.. Websocket services documentation

Websocket Services
==================

.. module:: xmm.services.websocket

The :class:`WebSocketServer` accepts websocket connections
from browsers and will provide different services on it.

By default, the server listens on port 8101. Deployment should
be done on the same hostname as the primary UI, to ensure that
authentication cookies will be sent with the websocket request.

Messages passed back and forth follow the common format::

   {
      "channel": "my_name",
      "payload": { "data": "here" }
   }

.. autoclass:: WebSocketServer
   :members:

Services
--------

.. autoclass:: xmm.services.notifier.Notifier
   :members:

.. autoclass:: xmm.services.clipboard.Clipboard
   :members: