.. include:: <isonum.txt>

Connections subpackage
======================

Each :doc:`setup <setups>` consists of different :doc:`components <components>` that each have their connection. The base class for connections is :class:`+eprcontrol.+connections.Connection`. Every connection should inherit from this class.

There are currently a number of derived classes serving as starting point for the different types of connections:

  * :class:`+eprcontrol.+connections.TcpipConnection`
  * :class:`+eprcontrol.+connections.XmlrpcConnection`

The other classes are derived from these base classes and are designed to connect to a particular software component, such as the Bruker Xenon software. Note that several :doc:`components <components>` can share one and the same connection. Currently, the following special connections are implemented:

  * :class:`+eprcontrol.+connections.BrukerXenonXmlrpcConnection`
  * :class:`+eprcontrol.+connections.GwuTcpipConnection`
  * :class:`+eprcontrol.+connections.LecroyTcpipConnection`
  * :class:`+eprcontrol.+connections.SpcmConnection`

See the respective class documentation below for details. While TCP/IP and XML-RPC are two rather general protocols, the actual connections are rather device-specific beyond the parameters necessary to connect to the device. Therefore, the different connections listed above each currently contain unique public methods designed to talk to the respective hardware.


Classes
-------

.. toctree::
   :maxdepth: 1

.. automodule:: +eprcontrol.+connections
    :members:
    :private-members: