api/spec/comp.h File Reference

ODP Compression. More...

#include <odp/visibility_begin.h>
#include <odp/api/event_types.h>
#include <odp/api/packet_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
#include <odp/visibility_end.h>

Include dependency graph for api/spec/comp.h:

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

Go to the source code of this file.

Data Structures
union	odp_comp_hash_algos_t
	Hash algorithms in a bit field structure. More...
union	odp_comp_algos_t
	Compression algorithms in a bit field structure. More...
struct	odp_comp_capability_t
	Compression Interface Capabilities. More...
struct	odp_comp_hash_alg_capability_t
	Hash algorithm capabilities. More...
struct	odp_comp_alg_capability_t
	Compression algorithm capabilities. More...
struct	odp_comp_deflate_param
	Compression DEFLATEe algorithm parameters. More...
union	odp_comp_alg_param_t
	Compression algorithm specific parameters. More...
struct	odp_comp_session_param_t
	Compression session creation parameters. More...
struct	odp_comp_packet_result_t
	Compression packet operation result. More...
struct	odp_comp_packet_op_param_t
	Compression per packet operation parameters. More...

Typedefs
typedef union odp_comp_hash_algos_t	odp_comp_hash_algos_t
	Hash algorithms in a bit field structure.
typedef union odp_comp_algos_t	odp_comp_algos_t
	Compression algorithms in a bit field structure.
typedef struct odp_comp_capability_t	odp_comp_capability_t
	Compression Interface Capabilities.
typedef struct odp_comp_hash_alg_capability_t	odp_comp_hash_alg_capability_t
	Hash algorithm capabilities.
typedef struct odp_comp_alg_capability_t	odp_comp_alg_capability_t
	Compression algorithm capabilities.
typedef enum odp_comp_huffman_code	odp_comp_huffman_code_t
	Compression Huffman type. More...
typedef struct odp_comp_deflate_param	odp_comp_deflate_param_t
	Compression DEFLATEe algorithm parameters. More...
typedef union odp_comp_alg_param_t	odp_comp_alg_param_t
	Compression algorithm specific parameters.
typedef struct odp_comp_session_param_t	odp_comp_session_param_t
	Compression session creation parameters.
typedef struct odp_comp_packet_result_t	odp_comp_packet_result_t
	Compression packet operation result.
typedef struct odp_comp_packet_op_param_t	odp_comp_packet_op_param_t
	Compression per packet operation parameters.

Enumerations
enum	odp_comp_op_mode_t { ODP_COMP_OP_MODE_SYNC , ODP_COMP_OP_MODE_ASYNC }
	Compression operation mode. More...
enum	odp_comp_op_t { ODP_COMP_OP_COMPRESS , ODP_COMP_OP_DECOMPRESS }
	Compression operation type. More...
enum	odp_comp_hash_alg_t { ODP_COMP_HASH_ALG_NONE , ODP_COMP_HASH_ALG_SHA1 , ODP_COMP_HASH_ALG_SHA256 }
	Compression hash algorithms. More...
enum	odp_comp_alg_t { ODP_COMP_ALG_NULL , ODP_COMP_ALG_DEFLATE , ODP_COMP_ALG_ZLIB , ODP_COMP_ALG_LZS }
	Compression algorithms. More...
enum	odp_comp_status_t { ODP_COMP_STATUS_SUCCESS , ODP_COMP_STATUS_OUT_OF_SPACE_TERM , ODP_COMP_STATUS_FAILURE }
	Compression operation status codes. More...
enum	odp_comp_huffman_code { ODP_COMP_HUFFMAN_FIXED , ODP_COMP_HUFFMAN_DYNAMIC , ODP_COMP_HUFFMAN_DEFAULT }
	Compression Huffman type. More...

Functions
int	odp_comp_capability (odp_comp_capability_t *capa)
	Query compression capabilities. More...
int	odp_comp_alg_capability (odp_comp_alg_t comp, odp_comp_alg_capability_t *capa)
	Query supported compression algorithm capabilities. More...
int	odp_comp_hash_alg_capability (odp_comp_hash_alg_t hash, odp_comp_hash_alg_capability_t *capa)
	Query supported hash algorithm capabilities. More...
void	odp_comp_session_param_init (odp_comp_session_param_t *param)
	Initialize compression session parameters. More...
odp_comp_session_t	odp_comp_session_create (const odp_comp_session_param_t *param)
	Compression session creation. More...
int	odp_comp_session_destroy (odp_comp_session_t session)
	Compression session destroy. More...
int	odp_comp_op (const odp_packet_t pkt_in[], odp_packet_t pkt_out[], int num_pkt, const odp_comp_packet_op_param_t param[])
	Synchronous packet compression operation. More...
int	odp_comp_op_enq (const odp_packet_t pkt_in[], odp_packet_t pkt_out[], int num_pkt, const odp_comp_packet_op_param_t param[])
	Asynchronous packet compression operation. More...
int	odp_comp_result (odp_comp_packet_result_t *result, odp_packet_t packet)
	Get compression operation results from processed packet. More...
odp_packet_t	odp_comp_packet_from_event (odp_event_t event)
	Convert compression processed packet event to packet handle. More...
odp_event_t	odp_comp_packet_to_event (odp_packet_t pkt)
	Convert processed packet handle to event. More...
uint64_t	odp_comp_session_to_u64 (odp_comp_session_t hdl)
	Get printable value for an odp_comp_session_t. More...

Detailed Description

ODP Compression.

Definition in file api/spec/comp.h.