fsp_plms_GetLauncherHeartbeat()

Synopsis:

#include <fsp/plms.h>

fsp_ResultType fsp_plms_GetLauncherHeartbeat ( fsp_plms_HandleType *plms_hdl,
                                               uint64_t *heartbeat_value ); 

Arguments:

plms_hdl

The PLMS handle returned in fsp_plms_Connect().

heartbeat_value

The current value of the heartbeat that will be returned by PLMS.

Library:

libplms

Use the -l plms option to qcc to link against this library.

Description:

The fsp_plms_GetLauncherHeartbeat() returns the current heartbeat value for the given plms_hdl. For example, a health monitoring application can use this call to monitor the plms state of health. The heartbeat is incremented by the period specified in the -h option.

Returns:

Returns valid hb_value and FSP_PLMS_STATUS_EOK on success or FSP_PLMS_STATUS_FAIL on error.

Example:

fsp_plms_GetLauncherHeartbeat(plms_hdl, &value);