QMEM.h File Reference

Public interface to the MEM package SSR data format. More...

#include <LSF/LSF.h>
#include <PBI/Endianness.h>

Classes
struct	_QMEM_Dump_Ident
	Indentifying information for a memory dump. More...
struct	_QMEM_Dump_Desc
	Description of a memory dump. More...
struct	_QMEM_Dump_Datagram
	LSF datagram for a memory dump. More...
Defines
#define	QMEM_VERSION_DGM   (1)
	Current version of the MEM package SSR datagram format.
#define	QMEM_VERSION_DESC   (1)
	Current version of the MEM package dump description format.
#define	QMEM_VERSION_DATA   (1)
	Current version of the MEM package dump data format.
Typedefs
typedef enum _QMEM_Id	QMEM_Id
	Typedef for _QMEM_Id.
typedef struct _QMEM_Dump_Ident	QMEM_Dump_Ident
	Typedef for _QMEM_Dump_Ident.
typedef struct _QMEM_Dump_Desc	QMEM_Dump_Desc
	Typedef for _QMEM_Dump_Desc.
typedef struct _QMEM_Dump_Datagram	QMEM_Dump_Datagram
	Typedef for _QMEM_Dump_Datagram.
Enumerations
enum	_QMEM_Id {   QMEM_ID_NONE = 0,   QMEM_ID_DESC = 1,   QMEM_ID_DATA = 2 }
	MEM package contribution IDs. More...
Functions
void	QMEM_dump (char *buf_p, unsigned int buf_bytes)
	Dump a MEM package datagram.

---

Detailed Description

Public interface to the MEM package SSR data format.

**  CVS $Id: QMEM.h,v 1.2 2011/03/29 01:58:52 apw Exp $
**  

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

---

Enumeration Type Documentation

enum _QMEM_Id

MEM package contribution IDs.

Enumerator:

QMEM_ID_NONE	Reserved ID value.
QMEM_ID_DESC	Dump description contribution.
QMEM_ID_DATA	Dump data contribution.

---

Function Documentation

void QMEM_dump	(	char *	buf_p,
		unsigned int	buf_bytes
	)

Dump a MEM package datagram.

Parameters:

	buf_p	Pointer to buffer containing the datagram.
	buf_bytes	Number of valid bytes in the buffer.

Returns:

Nothing.