Sends a request to retrieve the status for a given circuit.
S16 TUPGetCircStatus ( U8 board, CirIdx circID, TUPCircStatus *status)
Argument |
Description |
board |
TX board number. |
circID |
Circuit index for which to retrieve status. |
status |
Pointer to structure where retrieved status is placed. typedef struct _TupCircStatus /* TUP Circuit status */ Refer to the Details section for more information. |
Return value |
Description |
TUP_SUCCESS |
|
TUP_BOARD |
board is out of range. |
TUP_DRIVER |
Error occurred accessing the driver. |
TUP_FAILED |
Task on the TX board reported a failure. |
TUP_UNBOUND |
Application failed to call TUPInitMgmtAPI prior to this call. |
The circuitState element is coded as follows:
0x200 |
Initial |
0x201 |
Idle |
0x202 |
Idle, locally blocked |
0x203 |
Idle, remotely blocked |
0x204 |
Idle, remotely blocked, locally blocked |
0x205 |
Busy incoming |
0x206 |
Busy incoming, locally blocked |
0x207 |
Busy incoming, remotely blocked |
0x208 |
Busy incoming, remotely blocked, locally blocked |
0x209 |
Busy outgoing |
0x20A |
Busy outgoing, locally blocked |
0x20B |
Busy outgoing, remotely blocked |
0x20C |
Busy outgoing, remotely blocked, locally blocked |
0x20D |
Out of service locally |
0x20E |
Out of service locally, locally blocked |
0x20F |
Out of service locally, remotely blocked |
0x210 |
Out of service locally, remotely blocked, locally blocked |
0x211 |
Out of service remotely |
0x212 |
Out of service remotely, locally blocked |
0x213 |
Out of service remotely, remotely blocked |
0x214 |
Out of service remotely, remotely blocked, locally blocked |
0x215 |
Out of service BOTH |
0x216 |
Out of service BOTH, locally blocked |
0x217 |
Out of service BOTH, remotely blocked |
0x218 |
Out of service BOTH, remotely blocked, locally blocked |
The callState element is coded as follows:
Inbound busy circuit: |
|
0x300 |
Initial state |
0x301 |
Wait CLF state, in call |
0x302 |
Wait info state |
0x303 |
Wait answer state |
0x304 |
Wait ACM state |
0x305 |
Wait local RLG state |
0x306 |
Wait COT state |
0x307 |
Wait CCR state |
0x308 |
Wait CLF to end cont check state |
0x309 |
Dead state |
Outgoing busy circuit: |
|
0x400 |
Initial state |
0x401 |
Wait RLG state |
0x402 |
Wait release state |
0x403 |
Wait info state |
0x404 |
Wait answer state |
0x405 |
Wait ACM state |
0x406 |
Wait local COT state |
0x407 |
Wait local CONT CLF state |
0x408 |
Wait next CCR state |
0x409 |
Dead state |