axlJobIntfcHealthMethod

axlJobIntfcHealthMethod(
g_inst
S_currentHealth
)
=> S_newHealth

Description

Job Interface member function used to return the current health of the job. The application calls this function regularly (currently, every 5 seconds) on each job in order to recognize health changes. The available health types are: unknown, alive, or dead.

• unknown: If the job Interface detects that the process is still pending.
• alive: If the Job Interface detects that the job has been launched. Otherwise, the tool will eventually receive a start message from the remote job and automatically change the current health.
• alive: If the Job Interface detects that the job has exited.
• dead: Indicates that the remote communication has failed. Once marked dead, the health will not be queried. This is a terminal state.
  If no change is detected, the current state should be returned.

Arguments

g_inst	Subclass of axlJobIntfc
S_currentHealth	The current health type of the job. The valid values are unknown, alive, or dead.

Value Returned

S_newHealth

The health type of the job is returned.

Examples

Returns the health type of the job.

;; example setup
(defclass IPCJob ( axlJobIntfc )
    (
     (ipcHandle)
     ))
;; health method
(defmethod axlJobIntfcHealthMethod ( (inst IPCJob) current_health )
    (cond
     ((and (current_health == "unknown")
        (null (zerop (ipcGetExitStatus
inst->ipcHandle))))
     "dead")
  ((and (current_health == "alive")
     (null (ipcIsAliveProcess
inst->ipcHandle)))
     "dead")
  (t
  current_health)))

Return to top