rohc_comp_new2

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUE
NOTES
EXAMPLE
SEE ALSO

NAME

rohc_comp_new2 − Create a new ROHC compressor.

SYNOPSIS

#include <rohc/rohc_comp.h>

struct rohc_comp * rohc_comp_new2(
const rohc_cid_type_t cid_type,
const rohc_cid_t max_cid,
const rohc_comp_random_cb_t rand_cb,
void *const rand_priv
);

DESCRIPTION

Create a new ROHC compressor with the given type of CIDs and MAX_CID.

The user−defined callback for random numbers is called by the ROHC library every time a new random number is required. It currently happens only to initiate the Sequence Number (SN) of new IP−only, IP/UDP, or IP/UDP−Lite streams to a random value as defined by RFC 3095.

PARAMETERS

cid_type

The type of Context IDs (CID) that the ROHC compressor shall operate with. Accepted values are:

• ROHC_SMALL_CID for small CIDs

• ROHC_LARGE_CID for large CIDs

max_cid

The maximum value that the ROHC compressor should use for context IDs (CID). As CIDs starts with value 0, the number of contexts is max_cid + 1.
Accepted values are:

• [0, ROHC_SMALL_CID_MAX] if cid_type is ROHC_SMALL_CID

• [0, ROHC_LARGE_CID_MAX] if cid_type is ROHC_LARGE_CID

rand_cb

The random callback to set

rand_priv

Private data that will be given to the callback, may be used as a context by user

RETURN VALUE

The created compressor if successful, NULL if creation failed

NOTES

Don’t forget to free compressor memory with rohc_comp_free if rohc_comp_new2 succeeded

EXAMPLE

struct rohc_comp *compressor; /* the ROHC compressor */

compressor = rohc_comp_new2(ROHC_SMALL_CID, ROHC_SMALL_CID_MAX,
gen_random_num, NULL);
if(compressor == NULL)
{
fprintf(stderr, "failed create the ROHC compressor0);
goto error;
}

rohc_comp_free(compressor);