Obtains general status information about the MTP 3 signaling point.
MTP3_STATUS Mtp3GenStatus ( U8 board, MTP3GenStatus *pStats )
Argument |
Description |
board |
TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8). |
pStats |
Pointer to a buffer provided by the application where the requested statistics are returned: typedef struct _Mtp3GenStatus See the Details section for field descriptions. |
Return value |
Description |
MTP3_SUCCESS |
|
MTP3_BOARD |
Invalid board number. |
MTP3_HANDLE |
Mtp3MgmtInit not called for the specified board. |
The MTP3GenStatus structure includes a Boolean flag specifying whether or not the signaling point is in the process of restarting, and the current high-availability state. The following table describes the fields in the structure:
Field |
Description |
spRst |
If TRUE, indicates the signaling point is restarting. |
haState |
Must be one of the following: SN_HAST_STANDALONE = None (redundant state). SN_HAST_STARTING = Initial redundant state. SN_HAST_PRIMARY = MTP 3 is the primary in redundant state. SN_HAST_BACKUP = MTP 3 is the backup in redundant state. |