DEFINE_RTP_TUNING

DEFINE_RTP_TUNING specifies parameters to be used when setting up RTP connections. After you issue this verb, the parameters that you specify will be used for all future RTP connections, until you modify them by issuing a new DEFINE_RTP_TUNING verb.

VCB Structure

typedef struct define_rtp_tuning
{
  unsigned short   opcode;
  unsigned char    reserv2;
  unsigned char    format;
  unsigned short   primary_rc;
  unsigned long    secondary_rc;
  unsigned char    path_switch_attempts;
  unsigned char    short_req_retry_limit;
  unsigned short   path_switch_times[4];
  unsigned long    refifo_cap;
  unsigned long    srt_cap;
  unsigned short   path_switch_delay;
  unsigned char    reserved[78];
} DEFINE_RTP_TUNING;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_DEFINE_RTP_TUNING

path_switch_attempts

Number of path switch attempts for new RTP connections. Specify a value in the range 1–255.

Specify a value in the range 1–255. If you specify 0 (zero), Personal Communications or Communications Server uses the default value of 6.

short_req_retry_limit

Number of times a Status Request is sent before Personal Communications or Communications Server determines that an RTP connection is disconnected and starts Path Switch processing.

Specify a value in the range 1–255. If you specify 0 (zero), Personal Communications or Communications Server uses the default value of 6.

path_switch_times

Length of time in seconds for which Personal Communications or Communications Server attempts to path switch a disconnected RTP connection.

This parameter is specified as four separate time limits for each of the valid transmission priorities in order:

AP_LOW
AP_MEDIUM
AP_HIGH
AP_NETWORK

Each of these parameters should be in the range 1–65535. The value that you specify for each transmission priority must not exceed the value for any lower transmission priority.

If you specify 0 (zero) for any of the time limits, Personal Communications or Communications Server uses the corresponding default values:

AP_LOW: 480 seconds
AP_MEDIUM: 240 seconds
AP_HIGH: 120 seconds
AP_NETWORK : 60 seconds

refifo_cap

The RTP protocol uses the Re-FIFO Timer. The value of this timer is calculated as part of the protocol, but this parameter specifies a maximum value (in milliseconds). In some situations, setting this maximum value can improve performance.

Setting a value of 0 (zero) means that the timer is not limited and can take any value calculated by the protocol. The default value for this parameter is 4000 milliseconds, with a range of 250–12000 milliseconds.

srt_cap

The RTP protocol uses the Short Request Timer. The value of this timer is calculated as part of the protocol, but this parameter specifies a maximum value (in milliseconds). In some situations, setting this maximum value can improve performance.

Setting a value of 0 (zero) means that the timer is not limited and can take any value calculated by the protocol. The default value for this parameter is 8000 milliseconds, with a range of 500–24000 milliseconds.

path_switch_delay

Minimum delay in seconds before a path switch occurs. Specifying a delay avoids unnecessary path switch attempts caused by transient delays in network traffic, in particular when there is no other route available.

Specify a value in the range 0-65535. The default value is zero, indicating that a path switch attempt can occur as soon as the protocol indicates it is required.

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

Values are as follows:

AP_INVALID_PATH_SWITCH_TIMES: The path_switch_times parameter was not valid. For example, you might have specified a value for one transmission priority that exceeds the value specified for a lower transmission priority.