list.h File Reference

ROHC generic list decompression. More...

#include "comp_list.h"
#include "rohc_traces_internal.h"

Include dependency graph for decomp/schemes/list.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	list_decomp
	The context for list decompression. More...
Defines
#define	rd_list_warn(decomp_list, format,...)
#define	rd_list_debug(decomp_list, format,...)
Functions
int ROHC_EXPORT	rohc_list_decode_maybe (struct list_decomp *const decomp, const unsigned char *const packet, const size_t packet_len)
	Decompress the compressed list in given packet if present.
bool ROHC_EXPORT	rohc_decomp_list_create_item (struct list_decomp *const decomp, const unsigned int xi_index, const unsigned int xi_index_value, const uint8_t *const rohc_packet, const size_t rohc_max_len, size_t *const item_length)
	Create a list item from a XI item.

---

Detailed Description

ROHC generic list decompression.

Author:

Didier Barvaux <didier@barvaux.org>

---

Define Documentation

#define rd_list_debug	(		decomp_list,
			format,
			...
	)

Value:

rohc_debug(decomp_list, ROHC_TRACE_DECOMP, (decomp_list)->profile_id, \
                   format, ##__VA_ARGS__)

Print a debug trace for the given decompression list

#define rd_list_warn	(		decomp_list,
			format,
			...
	)

Value:

rohc_warning(decomp_list, ROHC_TRACE_DECOMP, (decomp_list)->profile_id, \
                     format, ##__VA_ARGS__)

Print a warning trace for the given decompression list

---

Function Documentation

bool ROHC_EXPORT rohc_decomp_list_create_item	(	struct list_decomp *const	decomp,
		const unsigned int	xi_index,
		const unsigned int	xi_index_value,
		const uint8_t *const	rohc_packet,
		const size_t	rohc_max_len,
		size_t *const	item_length
	)

Create a list item from a XI item.

Parameters:

	decomp	The context for list decompression
	xi_index	The XI index
	xi_index_value	The XI index value
	rohc_packet	The beginning of the XI item in the ROHC header
	rohc_max_len	The remaining length (in bytes) of the ROHC header
[out]	item_length	The length (in bytes) of the created item

Returns:

true if item was successfully created, false if a problem occurred

int ROHC_EXPORT rohc_list_decode_maybe	(	struct list_decomp *	decomp,
		const unsigned char *	packet,
		size_t	packet_len
	)

Decompress the compressed list in given packet if present.

Parameters:

decomp	The list decompressor
packet	The ROHC packet to decompress
packet_len	The remaining length of the packet to decode (in bytes)

Returns:

The size of the compressed list in packet in case of success, -1 in case of failure