.. _components-network:

Network
=======

The network components are used to communicate with the outside world. When the
:ref:`controller<components-controller>` is run in network mode a
:ref:`server<components-network-server>` is started which listens to incoming
connections. Each connection is handled by a
:ref:`client<components-network-client>` object.

Additionally, there are other modules within this component to abstract the
measurement state and the client configuration. The different message types are
defined as well.

Classes and structures
----------------------

.. contents::
    :local:
    :class: this-will-duplicate-information-and-it-is-still-useful-here

.. _components-network-server:

Server class
~~~~~~~~~~~~

.. doxygenclass:: nexmess::components::network::Server
    :members:
    :undoc-members:
    :protected-members:
    :private-members:

.. _components-network-client:

Client class
~~~~~~~~~~~~

.. doxygenclass:: nexmess::components::network::Client
    :members:
    :undoc-members:
    :protected-members:
    :private-members:

MeasurementConfig and TmpMeasurementConfig
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The measurement configuration is implemented in two different classes because
the measurement holds atomic values. To modify the measurement configuration a
temporary configuration is used by copying the current configuration into a
non-atomic version. This is then modified and copied back into the atomic
version.

.. doxygenclass:: nexmess::components::network::MeasurementConfig
    :members:
    :undoc-members:
    :protected-members:
    :private-members:

.. doxygenclass:: nexmess::components::network::TmpMeasurementConfig
    :members:
    :undoc-members:
    :protected-members:
    :private-members:

Client configuration structure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. doxygenstruct:: nexmess::components::network::ClientConfig
    :members:
    :undoc-members:
    :protected-members:
    :private-members:

Message types enumeration
~~~~~~~~~~~~~~~~~~~~~~~~~

.. doxygenenum:: nexmess::components::network::MessageType