\hypertarget{CDFP_8h}{
\section{CDFP.h File Reference}
\label{CDFP_8h}\index{CDFP.h@{CDFP.h}}
}
Public interface to produce Compressed Data Format. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=110pt]{CDFP_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{CDFP_8h_a0}{CDFP\_\-cfg\_\-sizeof} (int level)
\begin{CompactList}\small\item\em Returns the size, in bytes, of the compression configuration needed to support the specified compression level. \item\end{CompactList}\item 
int \hyperlink{CDFP_8h_a1}{CDFP\_\-cfg\_\-construct} (\hyperlink{struct__CDFP__cfg}{CDFP\_\-cfg} $\ast$cfg, int level)
\begin{CompactList}\small\item\em Constructs (initializes) the compression configuration for the appropriate level. \item\end{CompactList}\item 
int \hyperlink{CDFP_8h_a2}{CDFP\_\-sizeof} (int level, void $\ast$cfg)
\begin{CompactList}\small\item\em Returns the size, in bytes, of the compression structure needed to supprot the specified compression level. \item\end{CompactList}\item 
int \hyperlink{CDFP_8h_a3}{CDFP\_\-construct} (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$cdfp, int level, const \hyperlink{struct__CDFP__cfg}{CDFP\_\-cfg} $\ast$cfg, LSEW\_\-dgm\-Fw $\ast$dgm\-Fw, \hyperlink{struct__LSEPW}{LSEPW} $\ast$lsepw)
\begin{CompactList}\small\item\em Constructs (initializes) the compression structure for the appropriate level. \item\end{CompactList}\item 
unsigned int $\ast$ \hyperlink{CDFP_8h_a4}{CDFP\_\-begin\_\-add} (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$cdfp, unsigned int $\ast$buf, unsigned int len)
\begin{CompactList}\small\item\em Begin datagram callback routine. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Public interface to produce Compressed Data Format. 

\begin{Desc}
\item[Author:]JJRussell - \href{mailto:russell@slac.stanford.edu}{\tt russell@slac.stanford.edu}\end{Desc}


\footnotesize\begin{verbatim}    CVS $Id: CDFP.h,v 1.2 2007/02/14 06:23:14 russell Exp $

\end{verbatim}
\normalsize


\subsection{Function Documentation}
\hypertarget{CDFP_8h_a4}{
\index{CDFP.h@{CDFP.h}!CDFP_begin_add@{CDFP\_\-begin\_\-add}}
\index{CDFP_begin_add@{CDFP\_\-begin\_\-add}!CDFP.h@{CDFP.h}}
\subsubsection[CDFP\_\-begin\_\-add]{\setlength{\rightskip}{0pt plus 5cm}unsigned int $\ast$ CDFP\_\-begin\_\-add (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$ {\em cdfp}, unsigned int $\ast$ {\em beg}, unsigned int {\em len32})}}
\label{CDFP_8h_a4}


Begin datagram callback routine. 

\begin{Desc}
\item[Returns:]Pointer to the next write location\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cdfp}]The Compressed Data Format handle \item[{\em beg}]The output buffer \item[{\em len32}]The amount of space, in 32-bit words, available in the output buffer\end{description}
\end{Desc}
\hypertarget{CDFP_8h_a1}{
\index{CDFP.h@{CDFP.h}!CDFP_cfg_construct@{CDFP\_\-cfg\_\-construct}}
\index{CDFP_cfg_construct@{CDFP\_\-cfg\_\-construct}!CDFP.h@{CDFP.h}}
\subsubsection[CDFP\_\-cfg\_\-construct]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-cfg\_\-construct (\hyperlink{struct__CDFP__cfg}{CDFP\_\-cfg} $\ast$ {\em cfg}, int {\em level})}}
\label{CDFP_8h_a1}


Constructs (initializes) the compression configuration for the appropriate level. 

\begin{Desc}
\item[Returns:]Status\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cfg}]The compression configuratin to initialize \item[{\em level}]The maximum compression level that needs supporting\end{description}
\end{Desc}
\begin{Desc}
\item[Warning:]It is assumed that the caller has used CDFP\_\-cfg\_\-sizeof to determine the amount of storage that is needed and, thus, has assured that the {\em cfg\/} structure is adequately sized.\end{Desc}
\hypertarget{CDFP_8h_a0}{
\index{CDFP.h@{CDFP.h}!CDFP_cfg_sizeof@{CDFP\_\-cfg\_\-sizeof}}
\index{CDFP_cfg_sizeof@{CDFP\_\-cfg\_\-sizeof}!CDFP.h@{CDFP.h}}
\subsubsection[CDFP\_\-cfg\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-cfg\_\-sizeof (int {\em level})}}
\label{CDFP_8h_a0}


Returns the size, in bytes, of the compression configuration needed to support the specified compression level. 

\begin{Desc}
\item[Returns:]The size, in bytes, of the compression configuration\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em level}]The maximum compression level to support\end{description}
\end{Desc}
\hypertarget{CDFP_8h_a3}{
\index{CDFP.h@{CDFP.h}!CDFP_construct@{CDFP\_\-construct}}
\index{CDFP_construct@{CDFP\_\-construct}!CDFP.h@{CDFP.h}}
\subsubsection[CDFP\_\-construct]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-construct (\hyperlink{struct__CDFP__ctx}{CDFP\_\-ctx} $\ast$ {\em cdfp}, int {\em level}, const \hyperlink{struct__CDFP__cfg}{CDFP\_\-cfg} $\ast$ {\em cfg}, LSEW\_\-dgm\-Fw $\ast$ {\em dgm\-Fw}, \hyperlink{struct__LSEPW}{LSEPW} $\ast$ {\em lsepw})}}
\label{CDFP_8h_a3}


Constructs (initializes) the compression structure for the appropriate level. 

\begin{Desc}
\item[Returns:]Status\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cdfp}]The compression context to initialize \item[{\em level}]The maximum compression level that needs supporting \item[{\em cfg}]Target specific configuration parameter \item[{\em dgm\-Fw}]The datagram framework handle \item[{\em lsepw}]The generic LSEPW services\end{description}
\end{Desc}
\begin{Desc}
\item[Warning:]It is assumed that the called has used CDFP\_\-sizeof to determine the amount of storage that is needed and, thus, has assured that the {\em cmp\/} structure is adequately sized.\end{Desc}
\hypertarget{CDFP_8h_a2}{
\index{CDFP.h@{CDFP.h}!CDFP_sizeof@{CDFP\_\-sizeof}}
\index{CDFP_sizeof@{CDFP\_\-sizeof}!CDFP.h@{CDFP.h}}
\subsubsection[CDFP\_\-sizeof]{\setlength{\rightskip}{0pt plus 5cm}int CDFP\_\-sizeof (int {\em level}, void $\ast$ {\em cfg})}}
\label{CDFP_8h_a2}


Returns the size, in bytes, of the compression structure needed to supprot the specified compression level. 

\begin{Desc}
\item[Returns:]The size, in bytes, of the compression structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em level}]The maximum compression level to support \item[{\em cfg}]Level specific configuration parameter\end{description}
\end{Desc}
