.. _api-documentation:

API Documentation
=================

.. module:: hstreamdb

For examples about actual usage, see the :ref:`examples`.

Module Contents
---------------

Create Client
^^^^^^^^^^^^^

.. autofunction:: insecure_client
.. autofunction:: secure_client

HStreamDBClient Object
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: HStreamDBClient

BufferedProducer Object
^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: BufferedProducer

Consumer Object
^^^^^^^^^^^^^^^

.. autoclass:: Consumer

Types
^^^^^

.. autoclass:: TimeStamp

.. autoclass:: Stream

.. autoclass:: Subscription

.. autoclass:: RecordId

.. autoclass:: RecordHeader

.. autoclass:: Record