.. _code-reference:

==============
Code Reference
==============

Internal Documentation on the full source of sr3
Not an API. subject to change without notice.
What is missing:

* All flowcallbacks are here: `flowcb <flowcb.html>`_
* the entry points are excluded (not compatible with sphinx/autodoc.)

.. Contents::

sarracenia
----------

.. automodule:: sarracenia
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.config
-----------------

.. automodule:: sarracenia.config
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.credentials
----------------------

.. automodule:: sarracenia.credentials
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.diskqueue
--------------------

.. automodule:: sarracenia.diskqueue
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.filemetadata
-----------------------

.. automodule:: sarracenia.filemetadata
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow
---------------

.. automodule:: sarracenia.flow
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.poll
--------------------

.. automodule:: sarracenia.flow.poll
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.post
--------------------

.. automodule:: sarracenia.flow.post
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.report
----------------------

.. automodule:: sarracenia.flow.report
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.sarra
---------------------

.. automodule:: sarracenia.flow.sarra
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.sender
----------------------

.. automodule:: sarracenia.flow.sender
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.shovel
----------------------

.. automodule:: sarracenia.flow.shovel
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.subscribe
-------------------------

.. automodule:: sarracenia.flow.subscribe
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.watch
---------------------

.. automodule:: sarracenia.flow.watch
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.flow.winnow
----------------------

.. automodule:: sarracenia.flow.winnow
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.instance
-------------------

.. automodule:: sarracenia.instance
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.identity
--------------------

.. automodule:: sarracenia.identity
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.identity.arbitrary
------------------------------

.. automodule:: sarracenia.identity.arbitrary
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.identity.sha512
---------------------------

.. automodule:: sarracenia.identity.sha512
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.identity.md5
------------------------

.. automodule:: sarracenia.identity.md5
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.identity.random
---------------------------

.. automodule:: sarracenia.identity.random
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.moth
---------------

.. automodule:: sarracenia.moth
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.moth.amqp
--------------------

.. automodule:: sarracenia.moth.amqp
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.moth.pika
--------------------

.. automodule:: sarracenia.moth.pika
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.moth.mqtt
--------------------

.. automodule:: sarracenia.moth.mqtt
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.moth.amq1
--------------------

.. automodule:: sarracenia.moth.amq1
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.rabbitmq_admin
-------------------------

.. automodule:: sarracenia.rabbitmq_admin
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.transfer
-------------------

.. automodule:: sarracenia.transfer
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.transfer.file
------------------------

.. automodule:: sarracenia.transfer.file
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.transfer.https
-------------------------

.. automodule:: sarracenia.transfer.https
   :show-inheritance:
   :members:
   :private-members:
   :special-members:

sarracenia.transfer.ftp
-----------------------

.. automodule:: sarracenia.transfer.ftp
   :show-inheritance:
   :members:
   :private-members:
   :special-members:


sarracenia.transfer.sftp
------------------------

.. automodule:: sarracenia.transfer.sftp
   :show-inheritance:
   :members:
   :private-members:
   :special-members: