rohc_decomp_get_rate_limits

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
STRUCTURES
RETURN VALUE
SEE ALSO

NAME

rohc_decomp_get_rate_limits − Get the rate limits for feedbacks currently configured.

SYNOPSIS

#include <rohc/rohc_decomp.h>

bool rohc_decomp_get_rate_limits(
const struct rohc_decomp *const decomp
,
size_t *const k
,
size_t *const n
,
size_t *const k_1
,
size_t *const n_1
,
size_t *const k_2
,
size_t *const n_2

);

DESCRIPTION

Get the rate limits for positive feedbacks (ACK) and negative feedbacks (NACK and STATIC−NACK).

There are 3 different rate limits:

• the rate limit to avoid sending the same type of feedback too often: it applies to all feedback types (ACK, NACK, STATIC−NACK) and it is specified by the parameters k and n ;

• the rate limit to avoid sending NACKs too quickly after a sporadic CRC failure: it is specified by the parameters k_1 and n_1 ;

• the rate limit to avoid sending STATIC−NACKs too quickly after a sporadic CRC failure: it is specified by the parameters k_2 and n_2 ;

In all 3 cases above, the k/k_1/k_2 and n/n_1/n_2 parameters define 3 ratios of packets:

• a feedback is sent every k packets out of n packets that cause the same feedback type to be sent ;

• a NACK is not sent before k_1 packets out of n_1 packets failed because of a CRC failure in the Full Context state ;

• a STATIC−NACK is not sent before k_1 packets out of n_1 packets failed because of a CRC failure in the Static Context state ;

The default values are:

• k = 1 and n = default pRTT (see rohc_decomp_set_prtt for details)

• k_1 = 30 and n_1 = 100, ie. 30%

• k_2 = 30 and n_2 = 100, ie. 30%

If your network streams and conditions differ, change the default value.

PARAMETERS

decomp

The ROHC decompressor

k [output]

The k rate−limit parameter to avoid sending feedback too often

n [output]

The n rate−limit parameter to avoid sending feedback too often

k_1 [output]

The k_1 rate−limit param. to avoid sending NACKs too quickly

n_1 [output]

The n_1 rate−limit param. to avoid sending NACKs too quickly

k_2 [output]

The k_2 rate−limit param. to avoid sending STATIC−NACKs too quickly

n_2 [output]

The n_2 rate−limit param. to avoid sending STATIC−NACKs too quickly

STRUCTURES

RETURN VALUE

true if rate-limits were successfully retrieved, false otherwise

SEE ALSO

rohc_decomp.h(3), rohc_decomp_set_rate_limits(3), rohc_decomp_set_prtt(3), rohc_decomp_get_prtt(3), rohc_decompress3(3)