fsp_plms_WatchdogHeartbeat()

Synopsis:

#include <fsp/plms.h>

fsp_ResultType fsp_plms_WatchdogHeartbeat( fsp_plms_HandleType *plms_hdl ); 

Arguments:

plms_hdl

The PLMS handle returned in fsp_plms_Connect().

Library:

libplms

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

Description:

The fsp_plms_WatchdogHeartbeat() call sends the process heartbeat to PLMS. The caller must have connected to PLMS using fsp_plms_Connect() before calling fsp_plms_WatchdogHeartbeat(). The fsp_plms_WatchdogHeartbeat() should be called periodically based on the interval specified in the watchdog task of this process component in the configuration file.

Returns:

Returns FSP_PLMS_STATUS_EOK on success or FSP_PLMS_STATUS_FAIL on error.

Example:

fsp_plms_WatchdogHeartbeat(plms_hdl);