LSF_print.h File Reference

Interface to generic LSF print routines. More...

#include <LSF/LSF_scan.h>

Classes
struct	_LSF_printCtxCnts
	Global counts of datagrams, contributions and records. More...
struct	_LSF_printCtx
	Print context. More...
Typedefs
typedef struct _LSF_printCtxCnts	LSF_printCtxCnts
	Typedef for struct _LSF_printCtxCnts.
typedef struct _LSF_printCtx	LSF_printCtx
	struct _LSF_printCtx
Functions
unsigned int	LSF_printCtxSizeof (void *prm)
	Returns the size, in bytes, of the print context handle.
void	LSF_printCtxConstruct (LSF_printCtx *ctx, unsigned int options)
	Constructs/Initializes the print control context.
void	LSF_printCtxDestruct (LSF_printCtx *ctx)
	Destroys the print context.
LSF_scanContributionHandler	LSF_printDatagram (LSF_printCtx *ctx, const LSF_datagram *dgm)
	Prints the header of the specified datagram.
LSF_scanRecordHandler	LSF_printContribution (LSF_printCtx *ctx, const LSF_contribution *ctb)
	Prints the header of the specified contribution.
unsigned int	LSF_printRecord (LSF_printCtx *ctx, const LSF_record *rec)
	Prints the header of the specified contribution.
unsigned int	LSF_printDatagramHdr (const LSF_datagram_hdr *dgm_hdr, unsigned int dgm_seq)
	Prints a short, one-line dump of the datagram header.
unsigned int	LSF_printContributionHdr (const LSF_contribution_hdr *ctb_hdr, unsigned int ctb_seq)
	Prints a short, one-line dump of the contribution header.
unsigned int	LSF_printRecordHdr (const LSF_record_hdr *rec_hdr, unsigned int rec_seq)
	Prints a short, one-line dump of the record header.

---

Detailed Description

Interface to generic LSF print routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSF_print.h,v 1.5 2011/03/25 18:23:09 apw Exp $

---

Function Documentation

LSF_scanRecordHandler LSF_printContribution	(	LSF_printCtx *	ctx,
		const LSF_contribution *	ctb
	)

Prints the header of the specified contribution.

Return values:

0,indicating

to continue the scan

Parameters:

	ctx	Print context parameter
	ctb	The contribution to print

References _LSF_printCtxCnts::ctbs, _LSF_printCtx::ctbs, _LSF_contribution::hdr, LSF_printContributionHdr(), LSF_printRecord(), new_line(), _LSF_printCtx::recs, and _LSF_printCtx::tot.

Referenced by LSF_printDatagram().

unsigned int LSF_printContributionHdr	(	const LSF_contribution_hdr *	ctb_hdr,
		unsigned int	ctb_seq
	)

Prints a short, one-line dump of the contribution header.

Returns:

The number of characters printed to the screen

Parameters:

	ctb_hdr	The contribution header to print
	ctb_seq	A integer that identifies the number or sequence of this contribution

Warning:

No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

References _LSF_contribution_hdr::id, _LSF_contribution_hdr::len32, and _LSF_identity::ui.

Referenced by LSF_printContribution().

void LSF_printCtxConstruct	(	LSF_printCtx *	ctx,
		unsigned int	options
	)

Constructs/Initializes the print control context.

Parameters:

	ctx	The context to initialize
	options	Options flags, currently unused, specify as 0

References _LSF_printCtx::options.

void LSF_printCtxDestruct

(

LSF_printCtx *

ctx

)

Destroys the print context.

Parameters:

ctx

The context to destroy

This is a NOOP here only to statisfy interface requirements

unsigned int LSF_printCtxSizeof

(

void *

prm

)

Returns the size, in bytes, of the print context handle.

Returns:

The size, in bytes, of the print context handle

Parameters:

prm

Unused context parameter

LSF_scanContributionHandler LSF_printDatagram	(	LSF_printCtx *	ctx,
		const LSF_datagram *	dgm
	)

Prints the header of the specified datagram.

Return values:

0,indicating

to continue the scan

Parameters:

	ctx	Print context parameter
	dgm	The datagram to print

References _LSF_printCtx::ctbs, _LSF_printCtxCnts::dgms, _LSF_datagram::hdr, LSF_printContribution(), LSF_printDatagramHdr(), new_line(), and _LSF_printCtx::tot.

unsigned int LSF_printDatagramHdr	(	const LSF_datagram_hdr *	dgm_hdr,
		unsigned int	dgm_seq
	)

Prints a short, one-line dump of the datagram header.

Returns:

The number of characters printed to the screen

Parameters:

	dgm_hdr	The datagram header to print
	dgm_seq	A integer that identifies the number or sequence of this datagram

Warning:

No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

References _LSF_datagram_hdr::id, _LSF_datagram_hdr::len32, and _LSF_identity::ui.

Referenced by LSF_printDatagram().

unsigned int LSF_printRecord	(	LSF_printCtx *	ctx,
		const LSF_record *	rec
	)

Prints the header of the specified contribution.

Return values:

0,indicating

to continue the scan

Parameters:

	ctx	Print context parameter
	rec	The record to print

References _LSF_record::hdr, LSF_printRecordHdr(), new_line(), _LSF_printCtxCnts::recs, _LSF_printCtx::recs, and _LSF_printCtx::tot.

Referenced by LSF_printContribution().

unsigned int LSF_printRecordHdr	(	const LSF_record_hdr *	rec_hdr,
		unsigned int	rec_seq
	)

Prints a short, one-line dump of the record header.

Returns:

The number of characters printed to the screen

Parameters:

	rec_hdr	The record header to print
	rec_seq	A integer that identifies the number or sequence of this record

Warning:

No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

References _LSF_record_hdr::bf, _LSF_datagram::hdr, _LSF_record_hdr_bf::len32, _LSF_record_hdr_bf::type_id, and _LSF_record_hdr::ui.

Referenced by LSF_printRecord().