..
.. Copyright (C) Arm Ltd. 2021.  ALL RIGHTS RESERVED.
..
.. See file LICENSE for terms.
..

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

*  The full API specification can be found here : `HTML <https://openucx.github.io/ucx/api/v{VERSION}/html/index.html>`_ `PDF <https://openucx.github.io/ucx/api/v{VERSION}/ucx-v{VERSION}.pdf>`_
* `Code examples <https://github.com/openucx/ucx/tree/v{VERSION}.x/examples>`_

.. contents::
   :local:
   :depth: 3

Application Context routines
********************************
.. doxygengroup:: UCP_CONTEXT
    :project: openucx

Worker routines
*******************
.. doxygengroup:: UCP_WORKER
    :project: openucx

Endpoint routines
*********************
.. doxygengroup:: UCP_ENDPOINT
    :project: openucx

Data type routines
**********************
.. doxygengroup:: UCP_DATATYPE
    :project: openucx

Memory routines
*******************
.. doxygengroup:: UCP_MEM
    :project: openucx

Configuration routines
**************************
.. doxygengroup:: UCP_CONFIG
    :project: openucx

Communication routines
**************************
.. doxygengroup:: UCP_COMM
    :project: openucx

Wake-up routines
********************
.. doxygengroup:: UCP_WAKEUP
    :project: openucx

Resources
*************
.. doxygengroup:: UCS_RESOURCE
    :project: openucx

Index
*************
.. toctree::
   :glob:

   api/*
