OMGeeky/flucto-heisskleber
1
0
Fork 0
mirror of https://github.com/OMGeeky/flucto-heisskleber.git synced 2025-12-29 07:46:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
6facd5e8a7640eb2f87cf38cc060438feb221ef2
flucto-heisskleber/docs/reference.md
Felix Weiler-Detjen af767078bf Rename UnpackError to UnpackerError
2024-12-11 12:16:13 +01:00

1.8 KiB
Raw Blame History

Reference

Baseclasses

.. autoclass:: heisskleber.core.AsyncSink
   :members:

.. autoclass:: heisskleber.core.AsyncSource
   :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

.. autoclass:: heisskleber.core.unpacker::JSONUnpacker

.. autoclass:: heisskleber.core.packer::JSONPacker

Errors

.. autoclass:: heisskleber.core::UnpackerError

.. autoclass:: heisskleber.core::PackerError

Implementations (Adapters)

MQTT

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

.. autoclass:: heisskleber.mqtt.MqttSink
    :members: send

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

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

ZMQ

.. autoclass:: heisskleber.zmq::ZmqConf

.. autoclass:: heisskleber.zmq::ZmqSink
   :members: send

.. autoclass:: heisskleber.zmq::ZmqSource
   :members: receive

Serial

.. autoclass:: heisskleber.serial::SerialConf

.. autoclass:: heisskleber.serial::SerialSink
   :members: send

.. autoclass:: heisskleber.serial::SerialSource
   :members: receive

TCP

.. autoclass:: heisskleber.tcp::TcpConf

.. autoclass:: heisskleber.tcp::TcpSink
   :members: send

.. autoclass:: heisskleber.tcp::TcpSource
   :members: receive

UDP

.. autoclass:: heisskleber.udp::UdpConf

.. autoclass:: heisskleber.udp::UdpSink
   :members: send

.. autoclass:: heisskleber.udp::UdpSource
   :members: receive