websockets.integration
======================

.. py:module:: websockets.integration


Classes
-------

.. autoapisummary::

   websockets.integration.WebsocketsApp


Functions
---------

.. autoapisummary::

   websockets.integration.websocket_csp_tween_factory
   websockets.integration.get_js_path
   websockets.integration.get_websockets_asset


Module Contents
---------------

.. py:class:: WebsocketsApp

   Bases: :py:obj:`more.webassets.WebassetsApp`


   Add application-bound websocket broadcast communication.

   To receive broadcast messages using JavaScript in the browser, include the
   asset 'websockets' and call ``openWebsocket``.

   To send broadcast messages, call ``send_websocket`` with a
   JSON-serializable message.



   .. py:attribute:: configuration
      :type:  dict[str, Any]


   .. py:attribute:: _websockets_client_url
      :type:  str


   .. py:attribute:: websockets_manage_url
      :type:  str


   .. py:attribute:: websockets_manage_token
      :type:  str


   .. py:method:: configure_websockets(*, websockets: dict[str, Any] | None = None, **cfg: Any) -> None

      Configures global websocket settings. 



   .. py:method:: websockets_client_url(request: onegov.core.request.CoreRequest) -> str

      Returns the public websocket endpoint that can be used with JS.

      Upgrades the scheme to wss if request URL is https and fills in netloc
      based on the request URL if missing.



   .. py:property:: websockets_private_channel
      :type: str


      An unguessable channel ID used for broadcasting notifications
      through websockets to logged-in users.

      This is not meant to be safe, do not broadcast sensitive information!



   .. py:method:: send_websocket(message: onegov.core.types.JSON_ro, channel: str | None = None) -> bool

      Sends an application-bound broadcast message to all connected
      clients.




.. py:function:: websocket_csp_tween_factory(app: WebsocketsApp, handler: collections.abc.Callable[[onegov.core.request.CoreRequest], webob.response.Response]) -> collections.abc.Callable[[onegov.core.request.CoreRequest], webob.response.Response]

.. py:function:: get_js_path() -> str

.. py:function:: get_websockets_asset() -> collections.abc.Iterator[str]