:py:mod:`kosmos.protocols.protocol`
===================================

.. py:module:: kosmos.protocols.protocol







Classes
-------

.. py:class:: Protocol(config: kosmos.protocols.config.protocol.ProtocolConfig, network: kosmos.topology.net.Network)

   Bases: :py:class:`abc.ABC`

   Base class for all protocols.

   Initialize the protocol.

   :param config: Protocol configuration.
   :type config: ProtocolConfig
   :param network: The network topology.
   :type network: Network





   |

   .. rubric:: Methods

   .. py:method:: execute() -> kosmos.protocols.protocol_result.ProtocolResult

      Execute the protocol.

      :returns: Result of the protocol execution.
      :rtype: ProtocolResult