pressio.h File Reference

Pressio compressor loader. More...

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

Go to the source code of this file.

Functions
struct pressio *	pressio_instance ()
void	pressio_release (struct pressio *library)
struct pressio_compressor *	pressio_get_compressor (struct pressio *library, const char *compressor_id)
struct pressio_metrics *	pressio_new_metric (struct pressio *library, const char *const metric)
struct pressio_metrics *	pressio_new_metrics (struct pressio *library, const char *const metrics[], int num_metrics)
int	pressio_error_code (struct pressio *library)
const char *	pressio_error_msg (struct pressio *library)
const char *	pressio_version ()
const char *	pressio_features ()
const char *	pressio_supported_compressors ()
const char *	pressio_supported_metrics ()
unsigned int	pressio_major_version ()
unsigned int	pressio_minor_version ()
unsigned int	pressio_patch_version ()

Detailed Description

Pressio compressor loader.

Function Documentation

pressio_error_code()

int pressio_error_code

(

struct pressio *

library

)

Parameters

[in]

library

the pointer to the library

Returns

a machine-readable error code for the last error on the library object

pressio_error_msg()

const char * pressio_error_msg

(

struct pressio *

library

)

Parameters

[in]

library

the pointer to the library

Returns

a human-readable error message for the last error on the library object

pressio_features()

const char * pressio_features

(

)

Returns

a string containing all the features supported by this version separated by a space. Some features are compressors, but not all are.

See also

pressio_get_compressor the compressor_ids may be passed to pressio_get_compressor

pressio_get_compressor()

struct pressio_compressor * pressio_get_compressor	(	struct pressio *	library,
		const char *	compressor_id
	)

Parameters

[in]	library	the pointer to the library
[in]	compressor_id	the compressor to use

Returns

non-owning pointer to the requested instantiated pressio compressor; it may return the same pointer on multiple calls

See also

pressio_features for a list of available compressors

pressio_instance()

struct pressio * pressio_instance

(

)

gets a reference to a new instance of libpressio; initializes the library if necessary

Returns

a pointer to a library instance

pressio_major_version()

unsigned int pressio_major_version

(

)

Returns

the major version of the library

pressio_minor_version()

unsigned int pressio_minor_version

(

)

Returns

the minor version of the library

pressio_new_metric()

struct pressio_metrics * pressio_new_metric	(	struct pressio *	library,
		const char *const	metric
	)

creates a new metrics structure

Parameters

[in]	library	the pointer to the library
[in]	metric	a c-string for the metric requested

Returns

a new pressio_metrics structure

pressio_new_metrics()

struct pressio_metrics * pressio_new_metrics	(	struct pressio *	library,
		const char *const	metrics[],
		int	num_metrics
	)

creates a composite metrics structure

Parameters

[in]	library	the pointer to the library
[in]	metrics	a list of c-strings containing the list of metrics requested
[in]	num_metrics	the number of metrics requested

Returns

a new pressio_metrics structure

pressio_patch_version()

unsigned int pressio_patch_version

(

)

Returns

the patch version of the library

pressio_release()

void pressio_release

(

struct pressio *

library

)

Parameters

[in]

library

the pointer to the library

Returns

informs the library that this instance is no longer required; the pointer passed becomes invalid

pressio_supported_compressors()

const char * pressio_supported_compressors

(

)

Returns

a string containing all the compressors supported by this version separated by a space

See also

pressio_get_supported_compressors the compressor_ids may be passed to pressio_get_compressor

pressio_supported_metrics()

const char * pressio_supported_metrics

(

)

Returns

a string containing all the metrics supported by this version separated by a space

pressio_version()

const char * pressio_version

(

)

it will not return more information than the tailored functions below

Returns

a string with version and feature information