ROHC compression/decompression library
Macros | Typedefs | Enumerations | Functions
rohc.h File Reference

ROHC common definitions and routines. More...

#include <stdlib.h>
#include <stddef.h>
Include dependency graph for rohc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ROHC_DEPRECATED(msg)
 
#define ROHC_EXPORT
 
#define ROHC_ETHERTYPE   0x22f1
 The Ethertype assigned to the ROHC protocol by the IEEE. More...
 
#define ROHC_LARGE_CID_MAX   ((1U << 14) - 1) /* 2^14 - 1 = 16383 */
 The maximum value for large CIDs. More...
 
#define ROHC_SMALL_CID_MAX   15U
 The maximum value for small CIDs. More...
 

Typedefs

typedef size_t rohc_cid_t
 

Enumerations

enum  rohc_status_t {
  ROHC_STATUS_OK = 0, ROHC_STATUS_SEGMENT = 1, ROHC_STATUS_MALFORMED = 2, ROHC_STATUS_NO_CONTEXT = 3,
  ROHC_STATUS_BAD_CRC = 4, ROHC_STATUS_OUTPUT_TOO_SMALL = 5, ROHC_STATUS_ERROR = 6
}
 The status code of several functions in the library API. More...
 
enum  rohc_mode_t { ROHC_UNKNOWN_MODE = 0, ROHC_U_MODE = 1, ROHC_O_MODE = 2, ROHC_R_MODE = 3 }
 ROHC operation modes. More...
 
enum  rohc_cid_type_t { ROHC_LARGE_CID, ROHC_SMALL_CID }
 The different types of Context IDs (CID) More...
 
enum  rohc_profile_t {
  ROHC_PROFILE_UNCOMPRESSED = 0x0000, ROHC_PROFILE_RTP = 0x0001, ROHC_PROFILE_UDP = 0x0002, ROHC_PROFILE_ESP = 0x0003,
  ROHC_PROFILE_IP = 0x0004, ROHC_PROFILE_RTP_LLA = 0x0005, ROHC_PROFILE_TCP = 0x0006, ROHC_PROFILE_UDPLITE_RTP = 0x0007,
  ROHC_PROFILE_UDPLITE = 0x0008, ROHC_PROFILE_MAX = 0x0009
}
 The different ROHC compression/decompression profiles. More...
 

Functions

char *ROHC_EXPORT rohc_version (void)
 Get the version of the ROHC library. More...
 
const char *ROHC_EXPORT rohc_strerror (const rohc_status_t status)
 Give a description for the given ROHC status code. More...
 
const char *ROHC_EXPORT rohc_get_mode_descr (const rohc_mode_t mode)
 Give a description for the given ROHC mode. More...
 
const char *ROHC_EXPORT rohc_get_profile_descr (const rohc_profile_t profile)
 Give a description for the given ROHC profile. More...
 

Detailed Description

ROHC common definitions and routines.

Author
Didier Barvaux didie.nosp@m.r.ba.nosp@m.rvaux.nosp@m.@tou.nosp@m.louse.nosp@m..viv.nosp@m.eris..nosp@m.com
Didier Barvaux didie.nosp@m.r@ba.nosp@m.rvaux.nosp@m..org

Macro Definition Documentation

◆ ROHC_DEPRECATED

#define ROHC_DEPRECATED (   msg)

Macro that handles deprecated declarations gracefully

◆ ROHC_EXPORT

#define ROHC_EXPORT

Macro that handles DLL export declarations gracefully

Typedef Documentation

◆ rohc_cid_t

typedef size_t rohc_cid_t

A ROHC Context ID (CID)