PATH_SWITCH

The PATH_SWITCH verb requests Personal Communications or Communications Server to switch routes on a connection that supports high-performance routing (HPR). If a better path cannot be found, the connection is left unchanged.

VCB Structure

typedef struct path_switch
{
        unsigned short  opcode;         /* verb operation code   */
        unsigned char   reserv2;        /* reserved              */
        unsigned char   format;         /* format                */
        unsigned short  primary_rc;     /* primary return code   */
        unsigned long   secondary_rc;   /* secondary return code */
        unsigned char   rtp_connection_name[8];
                                        /* RTP connection name   */
} PATH_SWITCH;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_PATH_SWITCH
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
rtp_connection_name
Identifies the RTP connection to path-switch. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant and must be set.

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_RTP_CONNECTION
If the verb does not execute because of a state error, the Program returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_PATH_SWITCH_IN_PROGRESS
If the verb does not execute because the path switch attempt fails, the Program returns the following parameter:
primary_rc
AP_UNSUCCESSFUL
If the verb does not execute because the node is stopping, the Program returns the following parameter:
primary_rc
AP_NODE_STOPPING
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR