QUERY_RTP_TUNING

QUERY_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 QUERY_RTP_TUNING verb.

VCB Structure

typedef struct query_rtp_tuning
{
      AP_UINT16         opcode;                /* verb operation code             */
      unsigned char     reserv2;               /* reserved                        */
      unsigned char     format;                /* reserved                        */
      AP_UINT16         primary_rc;            /* primary return code             */
      AP_UINT32         secondary_rc;          /* secondary return code           */
      unsigned char     path_switch_attempts;  /* number of path switch attempts  */
      unsigned char     short_req_retry_limit; /* short request timer retry limit */
      AP_UINT16         path_switch_times[4];  /* path switch times               */
      AP_UINT32         refifo_cap;            /* maximum for refifo timer        */
      AP_UINT32         srt_cap;               /* maximum for short request timer */
      unsigned char     reserved[82];          /* reserved                        */
} QUERY_RTP_TUNING;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_RTP_TUNING

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
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:
  1. AP_LOW
  2. AP_MEDIUM
  3. AP_HIGH
  4. 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.

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.