\hypertarget{compress_8h}{\section{opal/mca/compress/compress.h File Reference}
\label{compress_8h}\index{opal/mca/compress/compress.\+h@{opal/mca/compress/compress.\+h}}
}


Compression Framework.  


{\ttfamily \#include \char`\"{}opal\+\_\+config.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/mca/mca.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/mca/base/base.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}opal/class/opal\+\_\+object.\+h\char`\"{}}\\*
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structopal__compress__base__component__2__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t}
\begin{DoxyCompactList}\small\item\em Structure for C\+O\+M\+P\+R\+E\+S\+S components. \end{DoxyCompactList}\item 
struct \hyperlink{structopal__compress__base__module__1__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+1\+\_\+0\+\_\+0\+\_\+t}
\begin{DoxyCompactList}\small\item\em Structure for C\+O\+M\+P\+R\+E\+S\+S modules. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{compress_8h_a6661ab90aeadb97069c53bba9d7456dd}{O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0}
\begin{DoxyCompactList}\small\item\em Macro for use in components that are of type C\+O\+M\+P\+R\+E\+S\+S. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef int($\ast$ \hyperlink{compress_8h_a80ba48ba8055ef516a92bc6362146afa}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t} )(void)
\begin{DoxyCompactList}\small\item\em Module initialization function. \end{DoxyCompactList}\item 
typedef int($\ast$ \hyperlink{compress_8h_a6c189053b68559b28bad1d8988767e62}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t} )(void)
\begin{DoxyCompactList}\small\item\em Module finalization function. \end{DoxyCompactList}\item 
typedef int($\ast$ \hyperlink{compress_8h_a6b5edff42062cdaf1783a5aa2cdfaf56}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t} )(char $\ast$fname, char $\ast$$\ast$cname, char $\ast$$\ast$postfix)
\begin{DoxyCompactList}\small\item\em Compress the file provided. \end{DoxyCompactList}\item 
\hypertarget{compress_8h_a9cd2669d834ab7ba1033842e0b35f943}{typedef int($\ast$ {\bfseries opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+nb\+\_\+fn\+\_\+t} )(char $\ast$fname, char $\ast$$\ast$cname, char $\ast$$\ast$postfix, pid\+\_\+t $\ast$child\+\_\+pid)}\label{compress_8h_a9cd2669d834ab7ba1033842e0b35f943}

\item 
typedef int($\ast$ \hyperlink{compress_8h_a71ce9ad7720d692650b54848080f68d4}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t} )(char $\ast$cname, char $\ast$$\ast$fname)
\begin{DoxyCompactList}\small\item\em Decompress the file provided. \end{DoxyCompactList}\item 
\hypertarget{compress_8h_a71312364683b654cafc3010ef2350d1c}{typedef int($\ast$ {\bfseries opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+nb\+\_\+fn\+\_\+t} )(char $\ast$cname, char $\ast$$\ast$fname, pid\+\_\+t $\ast$child\+\_\+pid)}\label{compress_8h_a71312364683b654cafc3010ef2350d1c}

\item 
\hypertarget{compress_8h_ae2e808db562c051c5062e7c9ffd6e95a}{typedef struct \\*
\hyperlink{structopal__compress__base__component__2__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t} {\bfseries opal\+\_\+compress\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t}}\label{compress_8h_ae2e808db562c051c5062e7c9ffd6e95a}

\item 
\hypertarget{compress_8h_a8f14798d232531c33b47e717e1ac8b57}{typedef struct \\*
\hyperlink{structopal__compress__base__component__2__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+component\+\_\+2\+\_\+0\+\_\+0\+\_\+t} {\bfseries opal\+\_\+compress\+\_\+base\+\_\+component\+\_\+t}}\label{compress_8h_a8f14798d232531c33b47e717e1ac8b57}

\item 
\hypertarget{compress_8h_a23a2dc1cca88762d601a3d42d82b2d5e}{typedef struct \\*
\hyperlink{structopal__compress__base__module__1__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+1\+\_\+0\+\_\+0\+\_\+t} {\bfseries opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+1\+\_\+0\+\_\+0\+\_\+t}}\label{compress_8h_a23a2dc1cca88762d601a3d42d82b2d5e}

\item 
\hypertarget{compress_8h_a6104b7b693553cba41af79a412ae763a}{typedef struct \\*
\hyperlink{structopal__compress__base__module__1__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+1\+\_\+0\+\_\+0\+\_\+t} {\bfseries opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+t}}\label{compress_8h_a6104b7b693553cba41af79a412ae763a}

\end{DoxyCompactItemize}
\subsection*{Variables}
\begin{DoxyCompactItemize}
\item 
\hypertarget{compress_8h_a83a2395781b788fba561561e9b9ad2ad}{O\+P\+A\+L\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C \\*
\hyperlink{structopal__compress__base__module__1__0__0__t}{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+t} {\bfseries opal\+\_\+compress}}\label{compress_8h_a83a2395781b788fba561561e9b9ad2ad}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Compression Framework. 

General Description\+:

The O\+P\+A\+L 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. 

\subsection{Macro Definition Documentation}
\hypertarget{compress_8h_a6661ab90aeadb97069c53bba9d7456dd}{\index{compress.\+h@{compress.\+h}!O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0@{O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0}}
\index{O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0@{O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0}!compress.\+h@{compress.\+h}}
\subsubsection[{O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0}]{\setlength{\rightskip}{0pt plus 5cm}\#define O\+P\+A\+L\+\_\+\+C\+O\+M\+P\+R\+E\+S\+S\+\_\+\+B\+A\+S\+E\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+2\+\_\+0\+\_\+0}}\label{compress_8h_a6661ab90aeadb97069c53bba9d7456dd}
{\bfseries Value\+:}
\begin{DoxyCode}
MCA\_BASE\_VERSION\_2\_0\_0, \(\backslash\)
    \textcolor{stringliteral}{"compress"}, 2, 0, 0
\end{DoxyCode}


Macro for use in components that are of type C\+O\+M\+P\+R\+E\+S\+S. 



\subsection{Typedef Documentation}
\hypertarget{compress_8h_a6b5edff42062cdaf1783a5aa2cdfaf56}{\index{compress.\+h@{compress.\+h}!opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t}}
\index{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t}!compress.\+h@{compress.\+h}}
\subsubsection[{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t}]{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$ opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+compress\+\_\+fn\+\_\+t)(char $\ast$fname, char $\ast$$\ast$cname, char $\ast$$\ast$postfix)}}\label{compress_8h_a6b5edff42062cdaf1783a5aa2cdfaf56}


Compress the file provided. 

Arguments\+: fname = Filename to compress cname = Compressed filename postfix = postfix added to filename to create compressed filename Returns\+: O\+P\+A\+L\+\_\+\+S\+U\+C\+C\+E\+S\+S on success, ow O\+P\+A\+L\+\_\+\+E\+R\+R\+O\+R \hypertarget{compress_8h_a71ce9ad7720d692650b54848080f68d4}{\index{compress.\+h@{compress.\+h}!opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t}}
\index{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t}!compress.\+h@{compress.\+h}}
\subsubsection[{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t}]{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$ opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+decompress\+\_\+fn\+\_\+t)(char $\ast$cname, char $\ast$$\ast$fname)}}\label{compress_8h_a71ce9ad7720d692650b54848080f68d4}


Decompress the file provided. 

Arguments\+: fname = Filename to compress cname = Compressed filename Returns\+: O\+P\+A\+L\+\_\+\+S\+U\+C\+C\+E\+S\+S on success, ow O\+P\+A\+L\+\_\+\+E\+R\+R\+O\+R \hypertarget{compress_8h_a6c189053b68559b28bad1d8988767e62}{\index{compress.\+h@{compress.\+h}!opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t}}
\index{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t}!compress.\+h@{compress.\+h}}
\subsubsection[{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t}]{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$ opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+finalize\+\_\+fn\+\_\+t)(void)}}\label{compress_8h_a6c189053b68559b28bad1d8988767e62}


Module finalization function. 

Returns O\+P\+A\+L\+\_\+\+S\+U\+C\+C\+E\+S\+S \hypertarget{compress_8h_a80ba48ba8055ef516a92bc6362146afa}{\index{compress.\+h@{compress.\+h}!opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t}}
\index{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t@{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t}!compress.\+h@{compress.\+h}}
\subsubsection[{opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t}]{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$ opal\+\_\+compress\+\_\+base\+\_\+module\+\_\+init\+\_\+fn\+\_\+t)(void)}}\label{compress_8h_a80ba48ba8055ef516a92bc6362146afa}


Module initialization function. 

Returns O\+P\+A\+L\+\_\+\+S\+U\+C\+C\+E\+S\+S 