SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
  Gets the statistics of the period.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
definition:
  default:
    attributes: null
    body: null
    params:
    - ${../../type/if/id:/name} ${.:/params[0]/name}
    - ${period-statistics:/name} *${.:/params[1]/name}
    return: ${../../status/if/code:/name}
  variants: []
description: |
  This directive returns the statistics of the rate monotonic period specified
  by ${.:/params[0]/name}.  The statistics of the period will be returned in
  the members of the period statistics object referenced by
  ${.:/params[1]/name}:

  * The ``count`` member is set to the number of periods executed.

  * The ``missed_count`` member is set to the number of periods missed.

  * The ``min_cpu_time`` member is set to the least amount of processor time
    used in the period.

  * The ``max_cpu_time`` member is set to the highest amount of processor time
    used in the period.

  * The ``total_cpu_time`` member is set to the total amount of processor time
    used in the period.

  * The ``min_wall_time`` member is set to the least amount of
    ${/glossary/clock-monotonic:/term} time used in the period.

  * The ``max_wall_time`` member is set to the highest amount of
    ${/glossary/clock-monotonic:/term} time used in the period.

  * The ``total_wall_time`` member is set to the total amount of
    ${/glossary/clock-monotonic:/term} time used in the period.
enabled-by: true
index-entries:
- get statistics of period
- obtain statistics of period
interface-type: function
links:
- role: interface-placement
  uid: header
- role: interface-ingroup
  uid: group
- role: constraint
  uid: /constraint/directive-not-pre-qualified
- role: constraint
  uid: /constraint/directive-ctx-task
- role: constraint
  uid: /constraint/directive-ctx-isr
- role: constraint
  uid: /constraint/directive-no-preempt
name: rtems_rate_monotonic_get_statistics
notes: null
params:
- description: |
    is the rate monotonic period identifier.
  dir: null
  name: id
- description: |
    is the pointer to an ${period-statistics:/name} object.  When the directive
    call is successful, the period statistics will be stored in this object.
  dir: out
  name: status
return:
  return: null
  return-values:
  - description: |
      The requested operation was successful.
    value: ${../../status/if/successful:/name}
  - description: |
      There was no rate monotonic period associated with the identifier
      specified by ${.:/params[0]/name}.
    value: ${../../status/if/invalid-id:/name}
  - description: |
      The ${.:/params[1]/name} parameter was ${/c/if/null:/name}.
    value: ${../../status/if/invalid-address:/name}
type: interface