\hypertarget{QMEM_8h}{
\section{QMEM.h File Reference}
\label{QMEM_8h}\index{QMEM.h@{QMEM.h}}
}
Public interface to the MEM package SSR data format.  


{\tt \#include $<$LSF/LSF.h$>$}\par
{\tt \#include $<$PBI/Endianness.h$>$}\par
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \hyperlink{struct__QMEM__Dump__Ident}{\_\-QMEM\_\-Dump\_\-Ident}
\begin{CompactList}\small\item\em Indentifying information for a memory dump. \item\end{CompactList}\item 
struct \hyperlink{struct__QMEM__Dump__Desc}{\_\-QMEM\_\-Dump\_\-Desc}
\begin{CompactList}\small\item\em Description of a memory dump. \item\end{CompactList}\item 
struct \hyperlink{struct__QMEM__Dump__Datagram}{\_\-QMEM\_\-Dump\_\-Datagram}
\begin{CompactList}\small\item\em LSF datagram for a memory dump. \item\end{CompactList}\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\hypertarget{QMEM_8h_371b0532ec7c1e03e9bc1e95964a1d0c}{
\#define \hyperlink{QMEM_8h_371b0532ec7c1e03e9bc1e95964a1d0c}{QMEM\_\-VERSION\_\-DGM}~(1)}
\label{QMEM_8h_371b0532ec7c1e03e9bc1e95964a1d0c}

\begin{CompactList}\small\item\em Current version of the MEM package SSR datagram format. \item\end{CompactList}\item 
\hypertarget{QMEM_8h_158f73b67ceb0273163e91d98d03ea3d}{
\#define \hyperlink{QMEM_8h_158f73b67ceb0273163e91d98d03ea3d}{QMEM\_\-VERSION\_\-DESC}~(1)}
\label{QMEM_8h_158f73b67ceb0273163e91d98d03ea3d}

\begin{CompactList}\small\item\em Current version of the MEM package dump description format. \item\end{CompactList}\item 
\hypertarget{QMEM_8h_a73592a81966363a6f0e34a6713f39c9}{
\#define \hyperlink{QMEM_8h_a73592a81966363a6f0e34a6713f39c9}{QMEM\_\-VERSION\_\-DATA}~(1)}
\label{QMEM_8h_a73592a81966363a6f0e34a6713f39c9}

\begin{CompactList}\small\item\em Current version of the MEM package dump data format. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{QMEM_8h_b78f6e89c6d3bdafc2949f073563159b}{
typedef enum \hyperlink{QMEM_8h_084c427ea564bb7f3c31c5de270abd59}{\_\-QMEM\_\-Id} \hyperlink{QMEM_8h_b78f6e89c6d3bdafc2949f073563159b}{QMEM\_\-Id}}
\label{QMEM_8h_b78f6e89c6d3bdafc2949f073563159b}

\begin{CompactList}\small\item\em Typedef for \_\-QMEM\_\-Id. \item\end{CompactList}\item 
\hypertarget{QMEM_8h_68e1321ea8d4589ccd7739b48f0949a4}{
typedef struct \hyperlink{struct__QMEM__Dump__Ident}{\_\-QMEM\_\-Dump\_\-Ident} \hyperlink{QMEM_8h_68e1321ea8d4589ccd7739b48f0949a4}{QMEM\_\-Dump\_\-Ident}}
\label{QMEM_8h_68e1321ea8d4589ccd7739b48f0949a4}

\begin{CompactList}\small\item\em Typedef for \hyperlink{struct__QMEM__Dump__Ident}{\_\-QMEM\_\-Dump\_\-Ident}. \item\end{CompactList}\item 
\hypertarget{QMEM_8h_f9d38e0a5f28e2ff60fd75491cb24ba3}{
typedef struct \hyperlink{struct__QMEM__Dump__Desc}{\_\-QMEM\_\-Dump\_\-Desc} \hyperlink{QMEM_8h_f9d38e0a5f28e2ff60fd75491cb24ba3}{QMEM\_\-Dump\_\-Desc}}
\label{QMEM_8h_f9d38e0a5f28e2ff60fd75491cb24ba3}

\begin{CompactList}\small\item\em Typedef for \hyperlink{struct__QMEM__Dump__Desc}{\_\-QMEM\_\-Dump\_\-Desc}. \item\end{CompactList}\item 
\hypertarget{QMEM_8h_4f8a84cfa2279478edb406a7921fff8a}{
typedef struct \hyperlink{struct__QMEM__Dump__Datagram}{\_\-QMEM\_\-Dump\_\-Datagram} \hyperlink{QMEM_8h_4f8a84cfa2279478edb406a7921fff8a}{QMEM\_\-Dump\_\-Datagram}}
\label{QMEM_8h_4f8a84cfa2279478edb406a7921fff8a}

\begin{CompactList}\small\item\em Typedef for \hyperlink{struct__QMEM__Dump__Datagram}{\_\-QMEM\_\-Dump\_\-Datagram}. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \hyperlink{QMEM_8h_084c427ea564bb7f3c31c5de270abd59}{\_\-QMEM\_\-Id} \{ \par
\hyperlink{QMEM_8h_084c427ea564bb7f3c31c5de270abd598cf4ab6c42aba5acd432bf4a48f968f2}{QMEM\_\-ID\_\-NONE} =  0, 
\par
\hyperlink{QMEM_8h_084c427ea564bb7f3c31c5de270abd59b6a4fbaa1974d8182ae8bab10009894b}{QMEM\_\-ID\_\-DESC} =  1, 
\par
\hyperlink{QMEM_8h_084c427ea564bb7f3c31c5de270abd5951cecf62aeff875bf700e805a3201c21}{QMEM\_\-ID\_\-DATA} =  2
 \}
\begin{CompactList}\small\item\em MEM package contribution IDs. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void \hyperlink{QMEM_8h_11196d033486d480f9a5501fadd9e5cf}{QMEM\_\-dump} (char $\ast$buf\_\-p, unsigned int buf\_\-bytes)
\begin{CompactList}\small\item\em Dump a MEM package datagram. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Public interface to the MEM package SSR data format. 



\footnotesize\begin{verbatim}
**  CVS $Id: QMEM.h,v 1.2 2011/03/29 01:58:52 apw Exp $
**  \end{verbatim}
\normalsize


Defines the public interface to the data structures that determine the format of memory dump data sent to the SSR. 

\subsection{Enumeration Type Documentation}
\hypertarget{QMEM_8h_084c427ea564bb7f3c31c5de270abd59}{
\index{QMEM.h@{QMEM.h}!\_\-QMEM\_\-Id@{\_\-QMEM\_\-Id}}
\index{\_\-QMEM\_\-Id@{\_\-QMEM\_\-Id}!QMEM.h@{QMEM.h}}
\subsubsection[{\_\-QMEM\_\-Id}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf \_\-QMEM\_\-Id}}}
\label{QMEM_8h_084c427ea564bb7f3c31c5de270abd59}


MEM package contribution IDs. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{QMEM\_\-ID\_\-NONE@{QMEM\_\-ID\_\-NONE}!QMEM.h@{QMEM.h}}\index{QMEM.h@{QMEM.h}!QMEM\_\-ID\_\-NONE@{QMEM\_\-ID\_\-NONE}}\item[{\em 
\hypertarget{QMEM_8h_084c427ea564bb7f3c31c5de270abd598cf4ab6c42aba5acd432bf4a48f968f2}{
QMEM\_\-ID\_\-NONE}
\label{QMEM_8h_084c427ea564bb7f3c31c5de270abd598cf4ab6c42aba5acd432bf4a48f968f2}
}]Reserved ID value. \index{QMEM\_\-ID\_\-DESC@{QMEM\_\-ID\_\-DESC}!QMEM.h@{QMEM.h}}\index{QMEM.h@{QMEM.h}!QMEM\_\-ID\_\-DESC@{QMEM\_\-ID\_\-DESC}}\item[{\em 
\hypertarget{QMEM_8h_084c427ea564bb7f3c31c5de270abd59b6a4fbaa1974d8182ae8bab10009894b}{
QMEM\_\-ID\_\-DESC}
\label{QMEM_8h_084c427ea564bb7f3c31c5de270abd59b6a4fbaa1974d8182ae8bab10009894b}
}]Dump description contribution. \index{QMEM\_\-ID\_\-DATA@{QMEM\_\-ID\_\-DATA}!QMEM.h@{QMEM.h}}\index{QMEM.h@{QMEM.h}!QMEM\_\-ID\_\-DATA@{QMEM\_\-ID\_\-DATA}}\item[{\em 
\hypertarget{QMEM_8h_084c427ea564bb7f3c31c5de270abd5951cecf62aeff875bf700e805a3201c21}{
QMEM\_\-ID\_\-DATA}
\label{QMEM_8h_084c427ea564bb7f3c31c5de270abd5951cecf62aeff875bf700e805a3201c21}
}]Dump data contribution. \end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QMEM_8h_11196d033486d480f9a5501fadd9e5cf}{
\index{QMEM.h@{QMEM.h}!QMEM\_\-dump@{QMEM\_\-dump}}
\index{QMEM\_\-dump@{QMEM\_\-dump}!QMEM.h@{QMEM.h}}
\subsubsection[{QMEM\_\-dump}]{\setlength{\rightskip}{0pt plus 5cm}void QMEM\_\-dump (char $\ast$ {\em buf\_\-p}, \/  unsigned int {\em buf\_\-bytes})}}
\label{QMEM_8h_11196d033486d480f9a5501fadd9e5cf}


Dump a MEM package datagram. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf\_\-p}]Pointer to buffer containing the datagram. \item[{\em buf\_\-bytes}]Number of valid bytes in the buffer.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Nothing. \end{Desc}
