RTEMS 4.6.2 On-Line Library

Rate Monotonic Manager RATE_MONOTONIC_PERIOD - Conclude current/Start next period

RTEMS C User's Guide

19.4.5: RATE_MONOTONIC_PERIOD - Conclude current/Start next period

CALLING SEQUENCE:

rtems_status_code rtems_rate_monotonic_period(
  rtems_id       id,
  rtems_interval length
);

DIRECTIVE STATUS CODES:

RTEMS_SUCCESSFUL - period initiated successfully
RTEMS_INVALID_ID - invalid rate monotonic period id
RTEMS_NOT_OWNER_OF_RESOURCE - period not created by calling task
RTEMS_NOT_DEFINED - period has never been initiated (only possible when period is set to PERIOD_STATUS)
RTEMS_TIMEOUT - period has expired

DESCRIPTION:

This directive initiates the rate monotonic period id with a length of period ticks. If id is running, then the calling task will block for the remainder of the period before reinitiating the period with the specified period. If id was not running (either expired or never initiated), the period is immediately initiated and the directive returns immediately.

If invoked with a period of RTEMS_PERIOD_STATUS ticks, the current state of id will be returned. The directive status indicates the current state of the period. This does not alter the state or period of the period.

NOTES:

This directive will not cause the running task to be preempted.

RTEMS C User's Guide