rohc_decomp_general_info_t Struct Reference

Some general information about the decompressor. More...

#include <rohc_decomp.h>

Data Fields
unsigned short	version_major
unsigned short	version_minor
size_t	contexts_nr
unsigned long	packets_nr
unsigned long	comp_bytes_nr
unsigned long	uncomp_bytes_nr
unsigned long	corrected_crc_failures
unsigned long	corrected_sn_wraparounds
unsigned long	corrected_wrong_sn_updates

Detailed Description

Some general information about the decompressor.

The structure is used by the rohc_decomp_get_general_info function to store some general information about the decompressor.

Versioning works as follow:

• The version_major field defines the compatibility level. If the major number given by user does not match the one expected by the library, an error is returned.
• The version_minor field defines the extension level. If the minor number given by user does not match the one expected by the library, only the fields supported in that minor version will be filled by rohc_decomp_get_general_info.

Notes for developers:

• Increase the major version if a field is removed.
• Increase the major version if a field is added at the beginning or in the middle of the structure.
• Increase the minor version if a field is added at the very end of the structure.
• The version_major and version_minor fields must be located at the very beginning of the structure.
• The structure must be packed.

Supported versions:

• major 0 and minor = 0 contains: version_major, version_minor, contexts_nr, packets_nr, comp_bytes_nr, and uncomp_bytes_nr.

See also

rohc_decomp_get_general_info

Field Documentation

unsigned long rohc_decomp_general_info_t::comp_bytes_nr

The number of compressed bytes received by the decompressor

size_t rohc_decomp_general_info_t::contexts_nr

The number of contexts used by the decompressor

unsigned long rohc_decomp_general_info_t::corrected_crc_failures

The cumulative number of successful corrections upon CRC failure

unsigned long rohc_decomp_general_info_t::corrected_sn_wraparounds

The cumulative number of successful corrections of SN wraparound upon CRC failure

unsigned long rohc_decomp_general_info_t::corrected_wrong_sn_updates

The cumulative number of successful corrections of incorrect SN updates upon CRC failure

unsigned long rohc_decomp_general_info_t::packets_nr

The number of packets processed by the decompressor

unsigned long rohc_decomp_general_info_t::uncomp_bytes_nr

The number of uncompressed bytes produced by the decompressor

unsigned short rohc_decomp_general_info_t::version_major

The major version of this structure

unsigned short rohc_decomp_general_info_t::version_minor

The minor version of this structure

---

The documentation for this struct was generated from the following file:

• rohc_decomp.h