.. _classes-and-functions:

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

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

Starting And Stopping The Async Machinery
*****************************************

.. automodule:: ansar.create.root

.. autofunction:: boot_up
.. autofunction:: start_up
.. autofunction:: tear_down
.. autofunction:: open_channel
.. autofunction:: drop_channel
.. autoclass:: OpenChannel

Implementation Of Standard Applications
***************************************

.. currentmodule:: ansar.create.object

.. autofunction:: create_object
.. autofunction:: object_executable
.. autofunction:: object_words
.. autofunction:: object_custom_settings
.. autofunction:: store_settings
.. autofunction:: object_resource_folder
.. autofunction:: object_tmp_folder
.. autofunction:: object_model_folder
.. autofunction:: object_resource_path
.. autofunction:: object_tmp_path
.. autofunction:: object_model_path


Implementation Of Asynchronous Objects
**************************************

.. automodule:: ansar.create.point

.. autoclass:: Point
.. automethod:: Point.create
.. automethod:: Point.send
.. automethod:: Point.reply
.. automethod:: Point.forward
.. automethod:: Point.advise
.. automethod:: Point.start
.. automethod:: Point.cancel
.. automethod:: Point.complete
.. automethod:: Point.assign
.. automethod:: Point.working
.. automethod:: Point.progress
.. automethod:: Point.running
.. automethod:: Point.abort
.. automethod:: Point.debrief
.. automethod:: Point.log
.. automethod:: Point.debug
.. automethod:: Point.trace
.. automethod:: Point.sample
.. automethod:: Point.console
.. automethod:: Point.warning
.. automethod:: Point.test
.. automethod:: Point.fault

.. autoclass:: PointLog
.. autoclass:: Threaded
.. autoclass:: Channel
.. autoclass:: T1

.. autoclass:: PointTest

.. autoclass:: AutoStop

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

.. autofunction:: halt

.. automodule:: ansar.create.binding

.. autofunction:: bind_any

.. currentmodule:: ansar.create.lifecycle

.. autoclass:: Start
.. autoclass:: Completed
.. autoclass:: Stop
.. autoclass:: Aborted
.. autoclass:: TimedOut
.. autoclass:: Nothing
.. autoclass:: Ready
.. autoclass:: Enquiry
.. autoclass:: Exhausted
.. autoclass:: Ack
.. autoclass:: Nak

.. currentmodule:: ansar.create.pending

.. autoclass:: Queue
.. autoclass:: SelectTimer
.. autoclass:: Player
.. autoclass:: Buffering
.. automethod:: Buffering.save
.. automethod:: Buffering.input
.. automethod:: Buffering.select
.. automethod:: Buffering.ask
.. automethod:: Buffering.stop
.. autoclass:: Dispatching

.. currentmodule:: ansar.create.machine

.. autoclass:: Stateless
.. autoclass:: StateMachine
.. autofunction:: bind_stateless
.. autofunction:: bind_statemachine

.. currentmodule:: ansar.create.test

.. autoclass:: TestReport
.. autoclass:: TestSuite

.. currentmodule:: ansar.create.object

.. autoclass:: ObjectSettings

Useful Asynchronous Objects
***************************

.. currentmodule:: ansar.create.processing

.. autoclass:: Process
.. autoclass:: Utility
.. autoclass:: Punctuation