Web Socket
==========

.. _WebSocketServerEvent:

WebSocketServerEvent
--------------------

TBD

.. code-block:: json

   enum WebSocketServerEvent {
      WEB_SOCKET_SERVER_EVENT_UNSPECIFIED = 0;
      WEB_SOCKET_SERVER_EVENT_CONNECTION = 1;
   }


+-----------------------------------------+-------+-------------+
| Value                                   | Tag   | Description |
+=========================================+=======+=============+
| ``WEB_SOCKET_SERVER_EVENT_UNSPECIFIED`` | ``0`` |             |
+-----------------------------------------+-------+-------------+
| ``WEB_SOCKET_SERVER_EVENT_CONNECTION``  | ``1`` |             |
+-----------------------------------------+-------+-------------+

.. _WebSocketNamespace:

WebSocketNamespace
------------------

TBD

.. code-block:: json

   enum WebSocketNamespace {
      WEB_SOCKET_NAMESPACE_UNSPECIFIED = 0;
      WEB_SOCKET_NAMESPACE_JOB_MANAGER = 1;
      WEB_SOCKET_NAMESPACE_COMMENTS = 2;
      // DEPRECATED
      WEB_SOCKET_NAMESPACE_DATAROOM = 3;
      WEB_SOCKET_NAMESPACE_DR = 4;
      WEB_SOCKET_NAMESPACE_USER = 5;
      WEB_SOCKET_NAMESPACE_COLLECTION = 6;
   }


+--------------------------------------+-------+-----------------+
| Value                                | Tag   | Description     |
+======================================+=======+=================+
| ``WEB_SOCKET_NAMESPACE_UNSPECIFIED`` | ``0`` |                 |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_JOB_MANAGER`` | ``1`` |                 |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_COMMENTS``    | ``2`` | **Deprecated.** |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_DATAROOM``    | ``3`` |                 |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_DR``          | ``4`` |                 |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_USER``        | ``5`` |                 |
+--------------------------------------+-------+-----------------+
| ``WEB_SOCKET_NAMESPACE_COLLECTION``  | ``6`` |                 |
+--------------------------------------+-------+-----------------+

.. _WebSocketClientEvent:

WebSocketClientEvent
--------------------

TBD

.. code-block:: json

   enum WebSocketClientEvent {
      WEB_SOCKET_CLIENT_EVENT_UNSPECIFIED = 0;
      WEB_SOCKET_CLIENT_EVENT_ERROR = 1;
      WEB_SOCKET_CLIENT_EVENT_CONNECT_ERROR = 2;
      WEB_SOCKET_CLIENT_EVENT_DISCONNECT = 3;
   }


+-------------------------------------------+-------+-----------------+
| Value                                     | Tag   | Description     |
+===========================================+=======+=================+
| ``WEB_SOCKET_CLIENT_EVENT_UNSPECIFIED``   | ``0`` |                 |
+-------------------------------------------+-------+-----------------+
| ``WEB_SOCKET_CLIENT_EVENT_ERROR``         | ``1`` |                 |
+-------------------------------------------+-------+-----------------+
| ``WEB_SOCKET_CLIENT_EVENT_CONNECT_ERROR`` | ``2`` |                 |
+-------------------------------------------+-------+-----------------+
| ``WEB_SOCKET_CLIENT_EVENT_DISCONNECT``    | ``3`` |                 |
+-------------------------------------------+-------+-----------------+

.. _WebSocketErrorType:

WebSocketErrorType
------------------

TBD

.. code-block:: json

   enum WebSocketErrorType {
      WEB_SOCKET_ERROR_TYPE_UNSPECIFIED = 0;
      WEB_SOCKET_ERROR_TYPE_AUTH = 1;
      WEB_SOCKET_ERROR_TYPE_PATH_LOCKED = 2;
   }


+---------------------------------------+-------+-------------+
| Value                                 | Tag   | Description |
+=======================================+=======+=============+
| ``WEB_SOCKET_ERROR_TYPE_UNSPECIFIED`` | ``0`` |             |
+---------------------------------------+-------+-------------+
| ``WEB_SOCKET_ERROR_TYPE_AUTH``        | ``1`` |             |
+---------------------------------------+-------+-------------+
| ``WEB_SOCKET_ERROR_TYPE_PATH_LOCKED`` | ``2`` |             |
+---------------------------------------+-------+-------------+