isupCircuitStatus

Sends a request to retrieve the status for a given circuit and blocks the calling application while waiting for a response.

Prototype

short isupCircuitStatus ( U8 board, U32 circId, IsupCircStatus *status)

Argument

Description

board

TX board number.

circId

Circuit for which to retrieve status.

status

Pointer to the following IsupCircStatus structure where the requested status information is returned:

typedef struct _IsupCircStatus        /* ISUP Circuit status   */
{
  DateTime dt;                /* Date and time                 */
  U8 transState;              /* Circuit transient state       */
  U8 callState;               /* Circuit call processing state */
  U16 fill1;
} IsupCircStatus;


Return values

Return value

Description

ISUP_SUCCESS

 

ISUP_BOARD

board is out of range.

ISUP_DRIVER

Error occurred accessing the driver.

ISUP_FAILED

Task on the TX board returned a failure.

ISUP_UNBOUND

Application failed to call isupInitMgmtAPI prior to this call.


Example

S16             status;
U8              boardNum = 1;
U32             circId = 1;
IsupCircStatus  circSta;

if ((status = isupCircuitStatus(boardNum, circuitId, &circSta)) != ISUP_MGMT_SUCCESS)
    printf( "Board %d Circuit %d Status Request failed: status = %d\n",
        boardNum, circuitId, status );
else
    printf( “Successfully retrieved circuit status for circuit %d on board %d\n",
        circuitId, boardNum );

/* The circSta structure contains the circuit status information */

}