\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 \char`\"{}LSF/LSF.h\char`\"{}}\par
{\tt \#include \char`\"{}PBI/Endianness.h\char`\"{}}\par


Include dependency graph for QMEM.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=121pt]{QMEM_8h__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=125pt]{QMEM_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Data Structures}
\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_a0}{
\#define \hyperlink{QMEM_8h_a0}{QMEM\_\-VERSION\_\-DGM}~(1)}
\label{QMEM_8h_a0}

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

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

\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_a3}{
typedef enum \hyperlink{QMEM_8h_a11}{\_\-QMEM\_\-Id} \hyperlink{QMEM_8h_a3}{QMEM\_\-Id}}
\label{QMEM_8h_a3}

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

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

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

\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_a11}{\_\-QMEM\_\-Id} \{ \par
\hyperlink{QMEM_8h_a11a7}{QMEM\_\-ID\_\-NONE} =  0, 
\par
\hyperlink{QMEM_8h_a11a8}{QMEM\_\-ID\_\-DESC} =  1, 
\par
\hyperlink{QMEM_8h_a11a9}{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_a10}{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.1 2005/09/21 16:45:08 dmay 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_a11}{
\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 \hyperlink{QMEM_8h_a11}{\_\-QMEM\_\-Id}}}
\label{QMEM_8h_a11}


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_a11a7}{
QMEM\_\-ID\_\-NONE}
\label{QMEM_8h_a11a7}
}]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_a11a8}{
QMEM\_\-ID\_\-DESC}
\label{QMEM_8h_a11a8}
}]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_a11a9}{
QMEM\_\-ID\_\-DATA}
\label{QMEM_8h_a11a9}
}]Dump data contribution.\end{description}
\end{Desc}



\subsection{Function Documentation}
\hypertarget{QMEM_8h_a10}{
\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_a10}


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}