Compression session creation parameters. More...

#include <comp.h>

Collaboration diagram for odp_comp_session_param_t:

Data Fields
odp_comp_op_t	op
	Compression operation type Compress vs Decompress.

odp_comp_op_mode_t	mode
	Compression operation mode. More...

odp_comp_alg_t	comp_algo
	Compression algorithm. More...

odp_comp_hash_alg_t	hash_algo
	Hash algorithm. More...

odp_comp_alg_param_t	alg_param
	parameters specific to compression

odp_bool_t	packet_order
	Session packet enqueue ordering Boolean to indicate if packet enqueue ordering is required per session. More...

odp_queue_t	compl_queue
	Destination queue for compression operations result. More...

Detailed Description

Compression session creation parameters.

Definition at line 283 of file api/spec/comp.h.

Field Documentation

◆ mode

odp_comp_op_mode_t odp_comp_session_param_t::mode

Compression operation mode.

Operation mode Synchronous vs Asynchronous

See also: odp_comp_op(), odp_comp_op_enq()

Definition at line 293 of file api/spec/comp.h.

◆ comp_algo

odp_comp_alg_t odp_comp_session_param_t::comp_algo

Compression algorithm.

See also: odp_comp_capability()

Definition at line 299 of file api/spec/comp.h.

◆ hash_algo

odp_comp_hash_alg_t odp_comp_session_param_t::hash_algo

Hash algorithm.

See also: odp_comp_alg_capability()

Definition at line 305 of file api/spec/comp.h.

◆ packet_order

odp_bool_t odp_comp_session_param_t::packet_order

Session packet enqueue ordering Boolean to indicate if packet enqueue ordering is required per session.

Valid only for Asynchronous operation mode (ODP_COMP_OP_MODE_ASYNC). Packet order is always maintained for synchronous operation mode (ODP_COMP_OP_MODE_SYNC)

true: packet session enqueue order maintained

false: packet session enqueue order is not maintained

Note: : By disabling packet order requirement, performance oriented application can leverage HW offered parallelism to increase operation performance.

Definition at line 324 of file api/spec/comp.h.

◆ compl_queue

odp_queue_t odp_comp_session_param_t::compl_queue

Destination queue for compression operations result.

Results are enqueued as ODP_EVENT_PACKET with subtype ODP_EVENT_PACKET_COMP

Definition at line 330 of file api/spec/comp.h.

The documentation for this struct was generated from the following file:

api/spec/comp.h