![]() |
![]() |
![]() |
> Module > HealthMonitor > ModuleHMTable |
Module
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>
Optional
None
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.
Optional
ConfigRecord
Unsigned 32 bit integer
An overflow event is not injected, event logging is determined by the handler.
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.
None
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.
Optional
ConfigRecord
Unsigned 32 bit integer
N/A
None
None
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.
Optional
ConfigRecord
Unsigned 32 bit integer
The module health monitor will not accept notification of any events. Events may be handled at one of the other levels.
0: The module health monitor will not accept notification of any events. Events may be handled at one of the other levels.
None
The threshold (in number of events) that, if crossed, generates an HME_HMQ_OVERFLOW event.
Optional
ConfigRecord
Unsigned 32 bit integer
Event generation is disabled.
0: Event generation is disabled.
The value must be at least two less than the value of /ConfigRecord/Module/HealthMonitor/ModuleHMTable/Settings/@maxLogEntries. The two spaces are required so that the current event and the overflow event can both go to the process level if desired by the system integrator.
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.
Optional
ConfigRecord
Unsigned 32 bit integer
N/A
None
None
The number of entries that the module health monitor log can hold.
Optional
ConfigRecord
Unsigned 32 bit integer
A value of 0 is used.
None
The lowest safe value is 3.
The upper bound is dependent on system configuration.
The number of events that can be queued for the module health monitor.
Optional
ConfigRecord
Unsigned 32 bit integer
Events are not queued.
None
The upper bound is dependent on system configuration.
The number of notifications that can be queued in the core OS waiting for delivery to the module health monitor.
Optional
ConfigRecord
Unsigned 32 bit integer
Notifications are not queued. Notifications are not performed.
0: Notifications are not queued. Notifications are not performed.
The upper bound is dependent on system configuration.
The name of the handler that is called when notification arrives.
Optional
ConfigRecord
String
No handler is defined.
CFG_NO_HANDLER: No handler is defined.
The maximum length is 30 characters.
The threshold (in number of events) that, if crossed, generates an event.
Optional
ConfigRecord
Unsigned 32 bit integer
Threshold boundary events are not generated.
0: Threshold boundary events are not generated.
The upper bound is dependent on system configuration.
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.
Optional
ConfigRecord
Unsigned 32 bit integer
A value of 0 is used.
None
The minimum size is 0x400 bytes.
The upper bound is dependent on system configuration.
Generated on 2007-10-15 17:17:22.