OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Variables
compress.h File Reference

Compression Framework. More...

`#include "opal_config.h"`
`#include "opal/mca/mca.h"`
`#include "opal/mca/base/base.h"`
`#include "opal/class/opal_object.h"`

Go to the source code of this file.

## Data Structures
struct | opal_compress_base_component_2_0_0_t
| Structure for COMPRESS components. More...
struct | opal_compress_base_module_1_0_0_t
| Structure for COMPRESS modules. More...

## Macros
#define | OPAL_COMPRESS_BASE_VERSION_2_0_0
| Macro for use in components that are of type COMPRESS. More...

## Typedefs
typedef int(* | opal_compress_base_module_init_fn_t )(void)
| Module initialization function. More...
typedef int(* | opal_compress_base_module_finalize_fn_t )(void)
| Module finalization function. More...
typedef int(* | opal_compress_base_module_compress_fn_t )(char *fname, char **cname, char **postfix)
| Compress the file provided. More...
typedef int(* | opal_compress_base_module_compress_nb_fn_t )(char *fname, char **cname, char **postfix, pid_t *child_pid)
typedef int(* | opal_compress_base_module_decompress_fn_t )(char *cname, char **fname)
| Decompress the file provided. More...
typedef int(* | opal_compress_base_module_decompress_nb_fn_t )(char *cname, char **fname, pid_t *child_pid)
typedef struct opal_compress_base_component_2_0_0_t | opal_compress_base_component_2_0_0_t
typedef struct opal_compress_base_component_2_0_0_t | opal_compress_base_component_t
typedef struct opal_compress_base_module_1_0_0_t | opal_compress_base_module_1_0_0_t
typedef struct opal_compress_base_module_1_0_0_t | opal_compress_base_module_t

## Variables
OPAL_DECLSPEC opal_compress_base_module_t | opal_compress

## Detailed Description

Compression Framework.

General Description:

The OPAL Compress framework has been created to provide an abstract interface to the compression agent library on the host machine. This fromework is useful when distributing files that can be compressed before sending to dimish the load on the network.

## Macro Definition Documentation

#define OPAL_COMPRESS_BASE_VERSION_2_0_0

Value:
MCA_BASE_VERSION_2_0_0, \
"compress", 2, 0, 0

Macro for use in components that are of type COMPRESS.

## Typedef Documentation

typedef int(* opal_compress_base_module_compress_fn_t)(char *fname, char **cname, char **postfix)

Compress the file provided.

Arguments: fname = Filename to compress cname = Compressed filename postfix = postfix added to filename to create compressed filename Returns: OPAL_SUCCESS on success, ow OPAL_ERROR

typedef int(* opal_compress_base_module_decompress_fn_t)(char *cname, char **fname)

Decompress the file provided.

Arguments: fname = Filename to compress cname = Compressed filename Returns: OPAL_SUCCESS on success, ow OPAL_ERROR

typedef int(* opal_compress_base_module_finalize_fn_t)(void)

Module finalization function.

Returns OPAL_SUCCESS

typedef int(* opal_compress_base_module_init_fn_t)(void)

Module initialization function.

Returns OPAL_SUCCESS