.. _classes-and-functions:

Classes And Functions
#####################

Reference information for the significant classes, methods and functions in the
library, appears here.

Listening And Connecting
************************

.. currentmodule:: ansar.connect.transporting

.. autofunction:: connect()
.. autofunction:: listen()

.. currentmodule:: ansar.connect.socketry

.. autoclass:: HostPort
.. autoclass:: SocketProxy
.. autoclass:: Connected()
.. autoclass:: Accepted()
.. autoclass:: Abandoned()
.. autoclass:: Closed()
.. autoclass:: CreateFrame()

Publish And Subscribe
*********************

.. currentmodule:: ansar.connect.directory

.. autofunction:: publish()
.. autofunction:: subscribe()

.. currentmodule:: ansar.connect.directory_if

.. autoclass:: Available()
.. autoclass:: Delivered()
.. autoclass:: Dropped()
.. autoclass:: Cleared()

Application Startup
*******************

.. currentmodule:: ansar.create.object

.. autofunction:: create_object

.. currentmodule:: ansar.connect.node

.. autofunction:: create_node

Connection Groups With Retry
****************************

.. currentmodule:: ansar.connect.grouping

.. autoclass:: GroupTable
.. autoclass:: GroupUpdate
.. automethod:: GroupTable.update
.. autoclass:: AddressGroup

.. currentmodule:: ansar.connect.networking

.. autoclass:: ConnectToAddress
.. autoclass:: ListenAtAddress
.. autoclass:: SubscribeToListing
.. autoclass:: PublishAListing
.. autoclass:: SubscribeToSearch

.. currentmodule:: ansar.connect.networking_if

.. autoclass:: UseAddress

HTTP Integration
****************

.. currentmodule:: ansar.connect.http

.. autoclass:: HttpRequest
.. autoclass:: HttpResponse

Ansar Create
************

Documentation appearing here belongs to the `ansar-create <https://pypi.org/project/ansar-create>`_ library. Some material
is duplicated here for convenient browsing.

.. _about-bind:

For convenience, the ``bind()`` function is maintained as a pointer-to-a-function.
It will be assigned to one of the two following functions, depending on which
ansar library is imported.

.. currentmodule:: ansar.encode.message

.. autofunction:: bind_message

.. currentmodule:: ansar.create.binding

.. autofunction:: bind_any

.. currentmodule:: ansar.create.point

.. autofunction:: bind_point
.. autofunction:: bind_function

.. currentmodule:: ansar.create.lifecycle

.. autoclass:: Completed()
.. autoclass:: Aborted()
.. autoclass:: Ack()
.. autoclass:: Stop()
.. autoclass:: Enquiry()

.. currentmodule:: ansar.create.point

.. autoclass:: Point()
.. automethod:: Point.create
.. automethod:: Point.send
.. automethod:: Point.reply
.. automethod:: Point.forward
.. automethod:: Point.start
.. automethod:: Point.cancel
.. automethod:: Point.complete
.. autoclass:: Threaded()
.. autoclass:: T1

.. currentmodule:: ansar.create.pending

.. automethod:: Buffering.select

.. currentmodule:: ansar.create.machine

.. autoclass:: Stateless
.. autoclass:: StateMachine

.. autofunction:: bind_stateless
.. autofunction:: bind_statemachine