QLFS.h File Reference

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

Classes
struct	_QLFS_DUMPSTFLAGS_Bfl
	File Dump Flags. More...
union	_QLFS_DUMPSTFLAGS
	Union for telemetry bitfield _QLFS_DUMPSTFLAGS_Bfl. More...
struct	_QLFS_DUMPSEQ_Bfl
	File Dump Sequence. More...
union	_QLFS_DUMPSEQ
	Union for telemetry bitfield _QLFS_DUMPSEQ_Bfl. More...
struct	_QLFS_FILESTID_Bfl
	File Storage ID. More...
union	_QLFS_FILESTID
	Union for telemetry bitfield _QLFS_FILESTID_Bfl. More...
struct	_QLFS_Dump_Desc
	Description of a file dump contribution. More...
struct	_QLFS_Dump_Datagram
	LSF datagram for a file dump. More...
Defines
#define	QLFS_VERSION_DGM   (2)
	Current version of the LFS package SSR datagram format.
#define	QLFS_VERSION_DESC   (2)
	Current version of the LFS package dump description format.
#define	QLFS_VERSION_DATA   (1)
	Current version of the LFS package dump data format.
Typedefs
typedef enum _QLFS_Id	QLFS_Id
	Typedef for _QLFS_Id.
typedef enum _QLFS_Dgm_Seq_Flags	QLFS_Dgm_Seq_Flags
	Typedef for _QLFS_Dgm_Seq_Flags.
typedef struct _QLFS_DUMPSTFLAGS_Bfl	QLFS_DUMPSTFLAGS_Bfl
	Typedef for telemetry bitfield structure _QLFS_DUMPSTFLAGS_Bfl.
typedef union _QLFS_DUMPSTFLAGS	QLFS_DUMPSTFLAGS
	Typedef for union _LFS_DUMPSTFLAGS.
typedef struct _QLFS_DUMPSEQ_Bfl	QLFS_DUMPSEQ_Bfl
	Typedef for telemetry bitfield structure _QLFS_DUMPSEQ_Bfl.
typedef union _QLFS_DUMPSEQ	QLFS_DUMPSEQ
	Typedef for union _QLFS_DUMPSEQ.
typedef struct _QLFS_FILESTID_Bfl	QLFS_FILESTID_Bfl
	Typedef for telemetry bitfield structure _QLFS_FILESTID_Bfl.
typedef union _QLFS_FILESTID	QLFS_FILESTID
	Typedef for union _QLFS_FILESTID.
typedef struct _QLFS_Dump_Desc	QLFS_Dump_Desc
	Typedef for _QLFS_Dump_Desc.
typedef struct _QLFS_Dump_Datagram	QLFS_Dump_Datagram
	Typedef for _QLFS_Dump_Datagram.
Enumerations
enum	_QLFS_Id {   QLFS_ID_NONE = 0,   QLFS_ID_DESC = 1,   QLFS_ID_DATA = 2 }
	LFS package contribution IDs. More...
enum	_QLFS_Dgm_Seq_Flags {   QLFS_DGM_SEQ_MID = 0,   QLFS_DGM_SEQ_FIRST = 1,   QLFS_DGM_SEQ_LAST = 2,   QLFS_DGM_SEQ_NONE = 3 }
	QLFS file dump datagram sequence flags. More...
Functions
void	QLFS_dump (const unsigned char *buf)
	Dump a LFS package datagram.

---

Detailed Description

**  CVS $Id: QLFS.h,v 1.6 2011/03/29 20:18:02 apw Exp $
**  

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

---

Enumeration Type Documentation

enum _QLFS_Dgm_Seq_Flags

QLFS file dump datagram sequence flags.

Enumerator:

QLFS_DGM_SEQ_MID	This datagram is in the middle of a sequence.
QLFS_DGM_SEQ_FIRST	This datagram is the first of a sequence.
QLFS_DGM_SEQ_LAST	This datagram is the last of a sequence.
QLFS_DGM_SEQ_NONE	This datagram is not part of a sequence.

enum _QLFS_Id

LFS package contribution IDs.

Enumerator:

QLFS_ID_NONE	Reserved ID value.
QLFS_ID_DESC	Dump description contribution.
QLFS_ID_DATA	Dump data contribution.

---

Function Documentation

void QLFS_dump

(

const unsigned char *

buf

)

Dump a LFS package datagram.

Parameters:

	buf	Pointer to buffer containing the datagram.
	buf	Pointer to buffer containing the datagram.

References _QLFS_DUMPSEQ::bf, _QLFS_DUMPSTFLAGS::bf, cpuIdStr, _QLFS_Dump_Datagram::desc, _QLFS_Dump_Datagram::desc_hdr, _QLFS_Dump_Datagram::dgm_hdr, _QLFS_Dump_Desc::dmpFlags, _QLFS_Dump_Desc::dmpSeq, _QLFS_Dump_Desc::fileId, _QLFS_Dump_Desc::fileOffset, _QLFS_Dump_Desc::fileSize, QLFS_VERSION_DESC, QLFS_VERSION_DGM, seqStr, and _QLFS_FILESTID::ui.