Previous Next  

Element: Settings

Document type

Module

Document XPath

/Module/HealthMonitor/ModuleHMTable/Settings

Schema XPath

/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings

Description

The Settings element defines the run-time behavior of the module health monitor. It also contains a list of TrustedPartition elements:

<Settings
 maxQueueDepth="34"
 queueThreshold="32"
 notificationHandler="TheNotificationHandler"
 notifMaxQueueDepth="5"
 eventFilterMask="0xFFFFFFFF"
 ...>
 <TrustedPartition ...”/>
 <TrustedPartition ...”/>
 <TrustedPartition ...”/>
</Settings>
			
Use

Optional

Children

TrustedPartition

Attributes

attributeMask

errorHandlerQueueThreshold

eventFilterMask

logEntriesThreshold

maxErrorHandlerQueueDepth

maxLogEntries

maxQueueDepth

notifMaxQueueDepth

notificationHandler

queueThreshold

stackSize

Restrictions

None

Attribute: attributeMask

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@attributeMask
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@attributeMask
Description

This value is a bitmask that configures various module health monitor attributes. The value is the logical OR of the desired attributes. Available attributes are HM_LOG_AUTOLOG (logs all events except HM_MSG) and HM_NOTIF_OVERFLOW_INJ (injects an event if the notification queue overflows). These symbols are defined in hmTypes.h.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

An overflow event is not injected, event logging is determined by the handler.

Values with special meanings

0x00000000: Events are not logged automatically. Events are not injected for notification queue overflows.

0x00000001: Events are logged automatically. Events are not injected for notification queue overflows.

0x00000002: Events are not logged automatically. Events are injected for notification queue overflows.

0x00000003: Events are logged automatically. Events are injected for notification queue overflows.

Restrictions

None

Attribute: errorHandlerQueueThreshold

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@errorHandlerQueueThreshold
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@errorHandlerQueueThreshold
Description

This attribute does not apply to the module health monitor. Any value supplied (or the default value if no value is supplied) is written to the configuration record but is not used.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: eventFilterMask

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@eventFilterMask
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@eventFilterMask
Description

This value is a bit mask that must have a bit set for each event for which the module health monitor will accept notification.

To determine the correct value for this field, look up the value of each of the entries of /ConfigRecord/Module/HealthMonitor/ModuleHMTable/SystemState/ErrorIDAction/@ErrorIdentifier for this module health monitor in hmTypes.h. Calculate the value which is the logical OR of these values. Enter that value as a hexadecimal number.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The module health monitor will not accept notification of any events. Events may be handled at one of the other levels.

Values with special meanings

0: The module health monitor will not accept notification of any events. Events may be handled at one of the other levels.

Restrictions

None

Attribute: logEntriesThreshold

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@logEntriesThreshold
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@logEntriesThreshold
Description

The threshold (in number of events) that, if crossed, generates an HME_HMQ_OVERFLOW event.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

Event generation is disabled.

Values with special meanings

0: Event generation is disabled.

Restrictions

Attribute: maxErrorHandlerQueueDepth

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@maxErrorHandlerQueueDepth
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@maxErrorHandlerQueueDepth
Description

This attribute does not apply to the module health monitor. The default value (or any value you supply) will be placed in the configuration record, but will not be used.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

None

Attribute: maxLogEntries

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@maxLogEntries
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@maxLogEntries
Description

The number of entries that the module health monitor log can hold.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

A value of 0 is used.

Values with special meanings

None

Restrictions

Attribute: maxQueueDepth

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@maxQueueDepth
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@maxQueueDepth
Description

The number of events that can be queued for the module health monitor.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

Events are not queued.

Values with special meanings

None

Restrictions

Attribute: notifMaxQueueDepth

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@notifMaxQueueDepth
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@notifMaxQueueDepth
Description

The number of notifications that can be queued in the core OS waiting for delivery to the module health monitor.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

Notifications are not queued. Notifications are not performed.

Values with special meanings

0: Notifications are not queued. Notifications are not performed.

Restrictions

Attribute: notificationHandler

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@notificationHandler
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@notificationHandler
Description

The name of the handler that is called when notification arrives.

Use

Optional

Target location

ConfigRecord

XML data type

xs:string

Destination data type

String

Behavior if not specified

No handler is defined.

Values with special meanings

CFG_NO_HANDLER: No handler is defined.

Restrictions

Attribute: queueThreshold

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@queueThreshold
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@queueThreshold
Description

The threshold (in number of events) that, if crossed, generates an event.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

Threshold boundary events are not generated.

Values with special meanings

0: Threshold boundary events are not generated.

Restrictions

Attribute: stackSize

Document XPath
/Module/HealthMonitor/ModuleHMTable/Settings/@stackSize
Schema XPath
/ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@stackSize
Description

The size (in bytes) of the module health monitor stack. The stack size required depends largely on the handlers being used by the health monitor. The minimum size is 0x400 bytes. The recommended size is 0x4000 bytes, when using the Wind River default health monitor handlers. You may need to increased this size if you install custom handlers that require more stack.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

A value of 0 is used.

Values with special meanings

None

Restrictions



Generated on 2007-10-15 17:17:22.