This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

HAM API Reference

The HAT includes the following functions you can use in your applications to interact with a HAM:

Function	Description
ham_action_control()	Perform control operations on an action object in a HAM.
ham_action_execute()	Add an execute action to a condition.
ham_action_fail_execute()	Add an execute action to an action, that will be executed if the corresponding action fails.
ham_action_fail_log()	Insert a log message into the activity log of a HAM.
ham_action_fail_notify_pulse()	Add a notify pulse action to an action, that will be executed if the corresponding action fails.
ham_action_fail_notify_pulse_node()	Add a notify pulse action to an action, that will be executed if the corresponding action fails, using a nodename.
ham_action_fail_notify_signal()	Add a notify signal action to an action, that will be executed if the corresponding action fails.
ham_action_fail_notify_signal_node()	Add a notify signal action to an action, that will be executed if the corresponding action fails, using a nodename.
ham_action_fail_waitfor()	Add a waitfor action to an action, that will be executed if the corresponding action fails
ham_action_handle()	Get a handle to an action in a condition in an entity.
ham_action_handle_node()	Get a handle to an action in a condition in an entity, using a nodename.
ham_action_handle_free()	Free a previously obtained handle to an action in a condition in an entity.
ham_action_heartbeat_healthy()	Reset a heartbeat's state to healthy.
ham_action_log()	Insert a log message into the activity log of the HAM.
ham_action_notify_pulse()	Add a notify-pulse action to a condition.
ham_action_notify_pulse_node()	Add a notify-pulse action to a condition, using a nodename.
ham_action_notify_signal()	Add a notify-signal action to a condition.
ham_action_notify_signal_node()	Add a notify-signal action to a condition, using a nodename.
ham_action_remove()	Remove an action from a condition.
ham_action_restart()	Add a restart action to a condition.
ham_action_waitfor()	Add a waitfor action to a condition.
ham_attach()	Attach an entity.
ham_attach_node()	Attach an entity, using a nodename.
ham_attach_self()	Attach an application as a self-attached entity.
ham_condition()	Set up a condition to be triggered when a certain event occurs.
ham_condition_control()	Perform control operations on a condition object in a HAM.
ham_condition_handle()	Get a handle to a condition in an entity.
ham_condition_handle_node()	Get a handle to a condition in an entity, using a nodename.
ham_condition_handle_free()	Free a previously obtained handle to a condition in an entity.
ham_condition_raise()	Attach a condition associated with a condition raise condition that is triggered by an entity raising a condition.
ham_condition_remove()	Remove a condition from an entity.
ham_condition_state()	Attach a condition associated with a state transition condition that is triggered by an entity reporting a state change.
ham_connect()	Connect to a HAM.
ham_connect_nd()	Connect to a remote HAM.
ham_connect_node()	Connect to a remote HAM, using a nodename.
ham_detach()	Detach an entity from a HAM.
ham_detach_name()	Detach an entity from a HAM, using an entity name.
ham_detach_name_node()	Detach an entity from a HAM, using an entity name and a nodename.
ham_detach_self()	Detach a self-attached entity from a HAM.
ham_disconnect()	Disconnect from a HAM.
ham_disconnect_nd()	Disconnect from a remote HAM.
ham_disconnect_node()	Disconnect from a remote HAM, using a nodename.
ham_entity()	Create entity placeholder objects in a HAM.
ham_entity_condition_raise()	Used by an entity to raise a condition.
ham_entity_condition_state()	Used by an entity to notify the HAM of a state transition.
ham_entity_control()	Perform control operations on an entity object in a HAM.
ham_entity_handle()	Get a handle to an entity.
ham_entity_handle_node()	Get a handle to an entity, using a nodename.
ham_entity_handle_free()	Free a previously obtained handle to an entity.
ham_entity_node()	Create entity placeholder objects in a HAM, using a nodename.
ham_heartbeat()	Send a heartbeat to a HAM.
ham_stop()	Stop a HAM.
ham_stop_nd()	Stop a remote HAM.
ham_stop_node()	Stop a remote HAM, using a nodename.
ham_verbose()	Modifies the verbosity of a HAM.