OMGeeky/flucto-heisskleber
1
0
Fork 0
mirror of https://github.com/OMGeeky/flucto-heisskleber.git synced 2025-12-26 16:07:50 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
flucto-heisskleber/docs/reference.md
Felix Weiler-Detjen f887416610 Rename classes in docs reference.
2025-02-05 12:15:09 +01:00

1.9 KiB
Raw Permalink Blame History

Reference

Baseclasses

.. autoclass:: heisskleber.Sender
   :members:

.. autoclass:: heisskleber.Receiver
   :members:

Serialization

See project:serialization.md for a tutorial on how to implement custom packer and unpacker for (de-)serialization.

.. autoclass:: heisskleber.core::Packer

.. autoclass:: heisskleber.core::Unpacker

Errors

.. autoclass:: heisskleber.core::UnpackerError

.. autoclass:: heisskleber.core::PackerError

Implementations (Adapters)

MQTT

.. automodule:: heisskleber.mqtt
    :no-members:

.. autoclass:: heisskleber.mqtt.MqttSender
    :members: send

.. autoclass:: heisskleber.mqtt.MqttReceiver
    :members: receive, subscribe

.. autoclass:: heisskleber.mqtt.MqttConf
    :members:

ZMQ

.. autoclass:: heisskleber.zmq::ZmqConf

.. autoclass:: heisskleber.zmq::ZmqSender
   :members: send

.. autoclass:: heisskleber.zmq::ZmqReceiver
   :members: receive

Serial

.. autoclass:: heisskleber.serial::SerialConf

.. autoclass:: heisskleber.serial::SerialSender
   :members: send

.. autoclass:: heisskleber.serial::SerialReceiver
   :members: receive

TCP

.. autoclass:: heisskleber.tcp::TcpConf

.. autoclass:: heisskleber.tcp::TcpSender
   :members: send

.. autoclass:: heisskleber.tcp::TcpReceiver
   :members: receive

UDP

.. autoclass:: heisskleber.udp::UdpConf

.. autoclass:: heisskleber.udp::UdpSender
   :members: send

.. autoclass:: heisskleber.udp::UdpReceiver
   :members: receive

File

.. autoclass:: heisskleber.file::FileConf

.. autoclass:: heisskleber.file::FileWriter
   :members: send

.. autoclass:: heisskleber.file::FileReader
   :members: receive