summaryrefslogtreecommitdiffstats
path: root/c-user/constant_bandwidth_server.rst
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
committerChris Johns <chrisj@rtems.org>2017-11-12 14:34:48 +1100
commit6c5640131fca82624f72b2bd33b5b5f46156626e (patch)
treeeca99c4c65ff8a3767a26a49f7aeca0af7eedfa0 /c-user/constant_bandwidth_server.rst
parentAdd indexes to all documents. (diff)
downloadrtems-docs-6c5640131fca82624f72b2bd33b5b5f46156626e.tar.bz2
c-user: Fix index locations.
Update #3229.
Diffstat (limited to 'c-user/constant_bandwidth_server.rst')
-rw-r--r--c-user/constant_bandwidth_server.rst59
1 files changed, 29 insertions, 30 deletions
diff --git a/c-user/constant_bandwidth_server.rst b/c-user/constant_bandwidth_server.rst
index 2db0daa..2a6ed40 100644
--- a/c-user/constant_bandwidth_server.rst
+++ b/c-user/constant_bandwidth_server.rst
@@ -42,12 +42,11 @@ provided by the CBS API are:
Background
==========
+.. index:: CBS parameters
+.. index:: rtems_cbs_parameters
Constant Bandwidth Server Definitions
-------------------------------------
-.. index:: CBS parameters
-
-.. index:: rtems_cbs_parameters
The Constant Bandwidth Server API enables tasks to communicate with the
scheduler and indicate its scheduling parameters. The scheduler has to be set
@@ -71,10 +70,10 @@ ordinary tasks that are not attached to any server.
In order to make the server effective to the executing tasks, tasks have to be
attached to the servers. The ``rtems_cbs_server_id`` is a type denoting an id
of a server and ``rtems_id`` a type for id of tasks.
+.. index:: CBS periodic tasks
Handling Periodic Tasks
-----------------------
-.. index:: CBS periodic tasks
Each task's execution begins with a default background priority (see the
chapter Scheduling Concepts to understand the concept of priorities in
@@ -84,10 +83,10 @@ of periodic behavior, or you declare deadline and budget using the CBS API in
which case these properties are constant for all subsequent periods, unless you
change them using the CBS API again. Task now only has to indicate and end of
each period using ``rtems_rate_monotonic_period``.
+.. index:: CBS overrun handler
Registering a Callback Function
-------------------------------
-.. index:: CBS overrun handler
In case tasks attached to servers are not aware of their execution time and
happen to exceed it, the scheduler does not guarantee execution any more and
@@ -113,10 +112,10 @@ The calling convention of the callback function is:
void overrun_handler(
rtems_cbs_server_id server_id
);
+.. index:: CBS limitations
Limitations
-----------
-.. index:: CBS limitations
When using this scheduler you have to keep in mind several things:
@@ -234,11 +233,11 @@ sequence, related constants, usage, and status codes.
\clearpage
.. _rtems_cbs_initialize:
+.. index:: initialize the CBS library
+.. index:: rtems_cbs_initialize
CBS_INITIALIZE - Initialize the CBS library
-------------------------------------------
-.. index:: initialize the CBS library
-.. index:: rtems_cbs_initialize
CALLING SEQUENCE:
.. code-block:: c
@@ -272,11 +271,11 @@ NOTES:
\clearpage
.. _rtems_cbs_cleanup:
+.. index:: cleanup the CBS library
+.. index:: rtems_cbs_cleanup
CBS_CLEANUP - Cleanup the CBS library
-------------------------------------
-.. index:: cleanup the CBS library
-.. index:: rtems_cbs_cleanup
CALLING SEQUENCE:
.. code-block:: c
@@ -302,11 +301,11 @@ NOTES:
\clearpage
.. _rtems_cbs_create_server:
+.. index:: create a new bandwidth server
+.. index:: rtems_cbs_create_server
CBS_CREATE_SERVER - Create a new bandwidth server
-------------------------------------------------
-.. index:: create a new bandwidth server
-.. index:: rtems_cbs_create_server
CALLING SEQUENCE:
.. code-block:: c
@@ -350,11 +349,11 @@ NOTES:
\clearpage
.. _rtems_cbs_attach_thread:
+.. index:: attach a thread to server
+.. index:: rtems_cbs_attach_thread
CBS_ATTACH_THREAD - Attach a thread to server
---------------------------------------------
-.. index:: attach a thread to server
-.. index:: rtems_cbs_attach_thread
CALLING SEQUENCE:
.. code-block:: c
@@ -392,11 +391,11 @@ NOTES:
\clearpage
.. _rtems_cbs_detach_thread:
+.. index:: detach a thread from server
+.. index:: rtems_cbs_detach_thread
CBS_DETACH_THREAD - Detach a thread from server
-----------------------------------------------
-.. index:: detach a thread from server
-.. index:: rtems_cbs_detach_thread
CALLING SEQUENCE:
.. code-block:: c
@@ -429,11 +428,11 @@ NOTES:
\clearpage
.. _rtems_cbs_destroy_server:
+.. index:: destroy a bandwidth server
+.. index:: rtems_cbs_destroy_server
CBS_DESTROY_SERVER - Destroy a bandwidth server
-----------------------------------------------
-.. index:: destroy a bandwidth server
-.. index:: rtems_cbs_destroy_server
CALLING SEQUENCE:
.. code-block:: c
@@ -466,11 +465,11 @@ NOTES:
\clearpage
.. _rtems_cbs_get_server_id:
+.. index:: get an ID of a server
+.. index:: rtems_cbs_get_server_id
CBS_GET_SERVER_ID - Get an ID of a server
-----------------------------------------
-.. index:: get an ID of a server
-.. index:: rtems_cbs_get_server_id
CALLING SEQUENCE:
.. code-block:: c
@@ -497,11 +496,11 @@ DESCRIPTION:
\clearpage
.. _rtems_cbs_get_parameters:
+.. index:: get scheduling parameters of a server
+.. index:: rtems_cbs_get_parameters
CBS_GET_PARAMETERS - Get scheduling parameters of a server
----------------------------------------------------------
-.. index:: get scheduling parameters of a server
-.. index:: rtems_cbs_get_parameters
CALLING SEQUENCE:
.. code-block:: c
@@ -534,11 +533,11 @@ NOTES:
\clearpage
.. _rtems_cbs_set_parameters:
+.. index:: set scheduling parameters
+.. index:: rtems_cbs_set_parameters
CBS_SET_PARAMETERS - Set scheduling parameters
----------------------------------------------
-.. index:: set scheduling parameters
-.. index:: rtems_cbs_set_parameters
CALLING SEQUENCE:
.. code-block:: c
@@ -573,11 +572,11 @@ NOTES:
\clearpage
.. _rtems_cbs_get_execution_time:
+.. index:: get elapsed execution time
+.. index:: rtems_cbs_get_execution_time
CBS_GET_EXECUTION_TIME - Get elapsed execution time
---------------------------------------------------
-.. index:: get elapsed execution time
-.. index:: rtems_cbs_get_execution_time
CALLING SEQUENCE:
.. code-block:: c
@@ -611,11 +610,11 @@ NOTES:
\clearpage
.. _rtems_cbs_get_remaining_budget:
+.. index:: get remaining execution time
+.. index:: rtems_cbs_get_remaining_budget
CBS_GET_REMAINING_BUDGET - Get remaining execution time
-------------------------------------------------------
-.. index:: get remaining execution time
-.. index:: rtems_cbs_get_remaining_budget
CALLING SEQUENCE:
.. code-block:: c
@@ -649,11 +648,11 @@ NOTES:
\clearpage
.. _rtems_cbs_get_approved_budget:
+.. index:: get scheduler approved execution time
+.. index:: rtems_cbs_get_approved_budget
CBS_GET_APPROVED_BUDGET - Get scheduler approved execution time
---------------------------------------------------------------
-.. index:: get scheduler approved execution time
-.. index:: rtems_cbs_get_approved_budget
CALLING SEQUENCE:
.. code-block:: c