hmiStatusReq

Retrieves the current HMI status and statistics.

Prototype

DWORD hmiStatusReq ( CTAHD ctahd, HmStatsData *pHmStats, U8 reset)

Argument

Description

ctahd

Natural Access handle from a previous successful call to ctaOpenServices.

pHmStats

Pointer to the statistics structure that is local to application memory:

typedef struct hmLnkStats
{
  U32 txHB;      /* number of link heartbeat messages transmitted   */
  U32 rxHB;      /* number of link heartbeat messages received      */
  U8  linkState; /* state of the IBC link, see hmidef.h             */
  U8  fill[3];
} HmLnkStats;


typedef struct hmTskStats
{
  U32 txLnkStInd;  /* number of link state change ind. transmitted     */
  U32 txRunStInd;  /* number of task state change ind. transmitted     */
  U32 rxHB;        /* number of link heartbeat mesg recvd from task    */
  U8  runState;    /* run state of task,incl HMRS_FAILED, see hmidef.h */
  U8  rxSeq;       /* RX sequence number                               */
  U8  txSeq;       /* TX sequence number                               */
  U8  remRunState; /* run state of remote task of same name            */
  U8  name[8];     /* task name                                        */
} HmTskStats;


typedef struct hmStatsData
{
  HmLnkStats linkStats;              /* statistics for the IBC link    */
  U8         numTsks;                /* number of tasks with statistics
                                        reported                       */
  U8         netState;               /* network connectivity state     */
  U8         fill[2];    
  HmTskStats taskStats[HM_MAXTASKS]; /* task statistics                */
} HmStatsData;

reset

If set to zero, do not reset counters. If non-zero, reset all counters.


The netState field in the HmStatsData structure applies to SIGTRAN configurations only. Valid values for netState are:

Return values

Return value

Description

SUCCESS

 

HMI_ERR_BADCMD

Request failed. An event handle was passed to the Health Management service command.

HMI_ERR_CLOSED

Request failed. Connection closed by HMI.

HMI_ERR_INTERROR

Request failed. Unknown I/O error occurred.

HMI_ERR_INVHANDLE

Handle is not valid.

HMI_ERR_NOMEM

No memory available.

HMI_ERR_REFUSED

Request failed because the board is in a halted state.

HMI_ERR_TIMEOUT

Request failed. No response from HMI.