ROHC compression/decompression library
Functions
ip_id_offset.h File Reference

Offset IP-ID decoding. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
#include "dllexport.h"
Include dependency graph for ip_id_offset.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

struct ip_id_offset_decode
*ROHC_EXPORT 
ip_id_offset_new (void)
 Create a new Offset IP-ID decoding context.
void ROHC_EXPORT ip_id_offset_free (struct ip_id_offset_decode *const ipid)
 Destroy a given Offset IP-ID decoding context.
bool ROHC_EXPORT ip_id_offset_decode (const struct ip_id_offset_decode *const ipid, const uint16_t m, const size_t k, const uint32_t sn, uint16_t *const decoded)
 Decode the given IP-ID offset.
void ROHC_EXPORT ip_id_offset_set_ref (struct ip_id_offset_decode *const ipid, const uint16_t id_ref, const uint32_t sn_ref)
 Update the reference values for the IP-ID and the SN.

Detailed Description

Offset IP-ID decoding.

Author:
Didier Barvaux <didier.barvaux@toulouse.viveris.com>
Didier Barvaux <didier@barvaux.org>

Function Documentation

bool ROHC_EXPORT ip_id_offset_decode ( const struct ip_id_offset_decode *const  ipid,
const uint16_t  m,
const size_t  k,
const uint32_t  sn,
uint16_t *const  decoded 
)

Decode the given IP-ID offset.

Parameters:
ipidThe Offset IP-ID object
mThe IP-ID offset to decode
kThe number of bits used to code the IP-ID offset
snThe SN of the ROHC packet that contains the IP-ID offset
decodedOUT: The computed IP-ID
Returns:
true in case of success, false otherwise
void ROHC_EXPORT ip_id_offset_free ( struct ip_id_offset_decode *const  ipid)

Destroy a given Offset IP-ID decoding context.

See 4.5.5 in the RFC 3095 for details about Offset IP-ID encoding.

Parameters:
ipidThe Offset IP-ID decoding context to destroy

Create a new Offset IP-ID decoding context.

See 4.5.5 in the RFC 3095 for details about Offset IP-ID encoding.

Returns:
The new Offset IP-ID decoding context in case of success, NULL otherwise
void ROHC_EXPORT ip_id_offset_set_ref ( struct ip_id_offset_decode *const  ipid,
const uint16_t  id_ref,
const uint32_t  sn_ref 
)

Update the reference values for the IP-ID and the SN.

Parameters:
ipidThe Offset IP-ID decoding object
id_refThe new IP-ID reference
sn_refThe new SN reference