bundle.website.builtin.components.websocket.base.messages
=========================================================

.. py:module:: bundle.website.builtin.components.websocket.base.messages


Classes
-------

.. autoapisummary::

   bundle.website.builtin.components.websocket.base.messages.KeepAliveMessage
   bundle.website.builtin.components.websocket.base.messages.AckMessage
   bundle.website.builtin.components.websocket.base.messages.ErrorMessage


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

.. py:class:: KeepAliveMessage(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`, :py:obj:`bundle.website.core.ws_messages.WebSocketDataMixin`


   Incoming keepalive ping message.


   .. py:attribute:: type
      :type:  Literal['keepalive']
      :value: 'keepalive'



   .. py:attribute:: sent_at
      :type:  int | None
      :value: None



   .. py:attribute:: payload
      :type:  str | None
      :value: None



.. py:class:: AckMessage(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`, :py:obj:`bundle.website.core.ws_messages.WebSocketDataMixin`


   Outgoing keepalive acknowledgement.


   .. py:attribute:: type
      :type:  Literal['keepalive_ack']
      :value: 'keepalive_ack'



   .. py:attribute:: sent_at
      :type:  int | None
      :value: None



   .. py:attribute:: received_at
      :type:  int


   .. py:attribute:: server_rx_packets
      :type:  int
      :value: 0



   .. py:attribute:: server_tx_packets
      :type:  int
      :value: 0



   .. py:attribute:: server_rx_bytes
      :type:  int
      :value: 0



   .. py:attribute:: server_tx_bytes
      :type:  int
      :value: 0



   .. py:attribute:: request_frame_bytes
      :type:  int
      :value: 0



   .. py:attribute:: request_payload_bytes
      :type:  int
      :value: 0



   .. py:attribute:: ack_frame_bytes
      :type:  int
      :value: 0



.. py:class:: ErrorMessage(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`, :py:obj:`bundle.website.core.ws_messages.WebSocketDataMixin`


   Outgoing protocol error message.


   .. py:attribute:: type
      :type:  Literal['error']
      :value: 'error'



   .. py:attribute:: message
      :type:  str