Core API
========

This section documents the core Flokkit Flow API.

Flow Builder
------------

The primary entry point for creating flows:

.. autofunction:: flow.flow

.. autoclass:: flow.FlowBuilder
   :members:
   :special-members: __init__
   :show-inheritance:

Core Components
---------------

Node Base Class
~~~~~~~~~~~~~~~

.. autoclass:: flow.Node
   :members:
   :special-members: __init__
   :show-inheritance:

Port
~~~~

.. autoclass:: flow.Port
   :members:
   :special-members: __init__
   :show-inheritance:

Connection
~~~~~~~~~~

.. autoclass:: flow.Connection
   :members:
   :special-members: __init__
   :show-inheritance:

Executable Graph
~~~~~~~~~~~~~~~~

.. autoclass:: flow.ExecutableGraph
   :members:
   :special-members: __init__
   :show-inheritance:

Enumerations
------------

Queue Full Strategy
~~~~~~~~~~~~~~~~~~~

.. autoclass:: flow.QueueFullStrategy
   :members:
   :undoc-members:
   :show-inheritance:

Shutdown Mode
~~~~~~~~~~~~~

.. autoclass:: flow.ShutdownMode
   :members:
   :undoc-members:
   :show-inheritance:

Middleware System
-----------------

Base Middleware
~~~~~~~~~~~~~~~

.. autoclass:: flow.Middleware
   :members:
   :special-members: __init__
   :show-inheritance:

Processing Context
~~~~~~~~~~~~~~~~~~

.. autoclass:: flow.ProcessingContext
   :members:
   :special-members: __init__
   :show-inheritance:

Built-in Middleware
~~~~~~~~~~~~~~~~~~~

.. autoclass:: flow.LoggingMiddleware
   :members:
   :special-members: __init__
   :show-inheritance:

.. autoclass:: flow.MetricsMiddleware
   :members:
   :special-members: __init__
   :show-inheritance:

.. autoclass:: flow.ThrottleMiddleware
   :members:
   :special-members: __init__
   :show-inheritance:

.. autoclass:: flow.RetryMiddleware
   :members:
   :special-members: __init__
   :show-inheritance:

Utility Functions
-----------------

Async Utilities
~~~~~~~~~~~~~~~

.. autofunction:: flow.ensure_async

Async Iterator Factory
~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: flow.AsyncIteratorAdapter