RtcplGetStarvationTimeout

The function RtcplGetStarvationTimeout returns the starvation timeout period.

Syntax

BOOL RtcplGetStarvationTimeout(
    PDWORD Behavior,
    PDWORD Timeout
);

Parameters

Behavior

Pointer to a DWORD that RtcplGetStarvationTimeout populates with one of the following defines:

Value	Description
STARVATION_YIELD	RTX performs a context switch from RTSS to Windows for the remaining time of the current tick.
STARVATION_FREEZE	RTX stops or freezes all RTSS applications, depending on the process exception disposition setting, which you can obtain with RtcplGetFreezeFaultingProcessOnException.
STARVATION_DISABLE	The starvation timer is disabled and so RTX does not monitor for Windows starvation.

Timeout

Pointer to a DWORD that RtcplGetStarvationTimeout populates with the number of microseconds of the starvation time out period.

Return Values

A non-zero value if the function succeeds, FALSE if the function fails

Remarks

You can make the RTX Scheduler monitor for highly CPU-intensive RTSS applications and notify the RTX subsystem if Windows has not been allowed to run for a period of time that you specify. The timeout value for Windows starvation depends on RTX load, Windows application load, and whether or not your application uses multimedia timers.

You can configure how RTX treats these Windows starvation notifications:

When notifications are treated as starvation exceptions, all RTSS applications are stopped or frozen.
When the notifications are treated as requests to yield to Windows, the RTX scheduler performs a context switch from RTSS to Windows for the remaining time of the current tick, possibly delaying an RTSS thread for up to one HAL timer period. This could affect some RTSS applications or drivers if there is a real time interrupt or timer being serviced at a very high rate (>10 KHz) and this latency is a significant fraction of the time between events. If this is the case, increase the starvation timeout value until the expected behavior is achieved.

Related RTX Properties Control Panel Features

Tab	Starvation tab
Feature(s)	Starvation options

Requirements

Header	RtxProp.h
Library	RtxProp.lib

| |