LPA_grb_post_p.h File Reference

LPA GRB event post private definitions. More...

#include <LPA_prvdefs.h>
#include <GRB/GRB_epu.h>
#include <GRB/GRB_pktdef.h>
#include <EDS/EDS_fwServices.h>
#include <PBS/FORK.h>
#include <PBS/WCT.h>
#include <PBS/WUT.h>

Classes
struct	_LPA_GrbProcessMethod
	Controls for posting GRB post buffers on timeouts. More...
struct	_LPA_GrbFlushOnTimeout
	Controls for posting GRB post buffers on timeouts. More...
struct	_LPA_GrbFlushMethod
	Method for performing the post buffer flush. More...
struct	_LPA_GrbPostCtl
	LPA GRB output control structure. More...
Defines
#define	LPA_MAX_GRB_DB   (8)
Typedefs
typedef unsigned int *(*	LPA_grbPoster )(void *prm, void *buf, int byt)
	Callback signature to post a buffer.
typedef struct _LPA_GrbProcessMethod	LPA_GrbProcessMethod
	Typedef for structure _LPA_GrbProcessMethod.
typedef struct _LPA_GrbFlushOnTimeout	LPA_GrbFlushOnTimeout
	Typedef for structure _LPA_GrbFlushOnTimeout.
typedef struct _LPA_GrbFlushMethod	LPA_GrbFlushMethod
	Typedef for structure _LPA_GrbFlushMethod.
typedef struct _LPA_GrbPostCtl	LPA_GrbPostCtl
	Typedef for structure _LPA_GrbPostCtl.
Functions
const EDS_fwPostServices *	LPA_constructGrbPostSvc (LPA_GrbPostCtl *ctl, EDS_fw *eds, void *postRtn, void *postPrm, unsigned int *buf, int buf_size)
	Construct the GRB output services.
unsigned int	LPA_grbPostCtlSizeOf (void)
	Retrieves the GRB post services control block size.
int	LPA_setGrbProcessor (void *prm, unsigned int id)
	Select the GRB processor to use.

---

Detailed Description

LPA GRB event post private definitions.

CVS $Id: LPA_grb_post_p.h,v 1.6 2011/03/28 22:24:21 russell Exp $

Author:

S.Maldonado

A.P.Waite

---

Typedef Documentation

unsigned int *(* LPA_grbPoster)(void *prm, void *buf, int byt)

Callback signature to post a buffer.

Returns:

Pointer to the next buffer to be filled.

Parameters:

	prm	Arbitrary user context parameter
	buf	The buffer to post
	nbytes	The number of bytes in the buffer

---

Function Documentation

const EDS_fwPostServices* LPA_constructGrbPostSvc	(	LPA_GrbPostCtl *	gpc,
		EDS_fw *	eds,
		void *	postRtn,
		void *	postPrm,
		unsigned int *	buf,
		int	buf_size
	)

Construct the GRB output services.

Parameters:

	gpc	(in) The GRB poster control handle
	eds	(in) The EDS framework handle
	postRtn	(in) Routine to post the formatted GRB summary
	postPrm	(in) Parameter passed to the post routine
	buf	(in) The first, preallocated buffer to fill
	buf_size	(in) The size, in bytes, of the ouptut buffer. Events will be packed into this buffer until full

Return values:

	NULL	Failure
	x	Success (pointer to EDS_fwPostServices)

References _LPA_GrbPostCtl::act, _LPA_GrbFlushOnTimeout::delta, _LPA_GrbPostCtl::fot, _LPA_GrbFlushOnTimeout::fqi, _LPA_GrbPostCtl::gfm, _LPA_GrbPostCtl::gpm, _LPA_GrbPostCtl::hdr, LPA_grbPostFlush(), LPA_grbPostNotify(), LPA_grbPostStart(), LPA_grbPostWrite(), _LPA_GrbPostCtl::max, _LPA_GrbPostCtl::msg, _LPA_GrbPostCtl::nid, _LPA_GrbFlushMethod::prm, _LPA_GrbProcessMethod::prm, _LPA_GrbFlushMethod::rtn, _LPA_GrbPostCtl::siz, _LPA_GrbProcessMethod::svc, and _LPA_GrbFlushOnTimeout::wut.

Referenced by LPA_configOutput().

unsigned int LPA_grbPostCtlSizeOf

(

void

)

Retrieves the GRB post services control block size.

Returns:

Size of GRB post services control block

Referenced by LPA_configOutput().

int LPA_setGrbProcessor	(	void *	prm,
		unsigned int	id
	)

Select the GRB processor to use.

Parameters:

	prm	(in) GRB post control handle
	id	(in) GRB processor ID

Return values:

	0	Success
	-1	Failure

References _LPA_GrbPostCtl::act, _LPA_GrbPostCtl::gpm, and _LPA_GrbProcessMethod::prm.

Referenced by LPA_change_grb().