Some general information about the compressor. More...

#include <rohc_comp.h>

Detailed Description

Some general information about the compressor.

The structure is used by the rohc_comp_get_general_info function to store some general information about the compressor.

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_comp_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, uncomp_bytes_nr, and comp_bytes_nr.

Field Documentation

unsigned long rohc_comp_general_info_t::comp_bytes_nr

The number of compressed bytes produced by the compressor

size_t rohc_comp_general_info_t::contexts_nr

The number of contexts used by the compressor

unsigned long rohc_comp_general_info_t::packets_nr

The number of packets processed by the compressor

unsigned long rohc_comp_general_info_t::uncomp_bytes_nr

The number of uncompressed bytes received by the compressor

unsigned short rohc_comp_general_info_t::version_major

The major version of this structure

unsigned short rohc_comp_general_info_t::version_minor

The minor version of this structure

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