EDS_fwPvt.h File Reference

The EDS framework control structure. This is private to the EDS package. More...

#include <EDS/EDS_cfg.h>

Classes
struct	_EDS_fwMem
	The memory manager for the framework. More...
struct	_EDS_fwIxbObjDsc
	Describes the static properties of the framework's event objects. More...
struct	_EDS_fwIxbObjTbl
	The table of managed objects. More...
struct	_EDS_fwFateNeeds
	This keeps track of both the statically declared needs and the currently active needs. More...
struct	_EDS_fwSynchCtx
	The context needed to synchronize with the event deliver task. More...
struct	_EDS_fwHandlerRegisteredServices
	The registered services. More...
struct	_EDS_fwHandler
	Holds the context for one registered callback handler. More...
struct	_EDS_fwHandlerCfgs
	Holds the current configuration for each of the installed handlers. More...
struct	_EDS_fwPoster
	The post context structure for one poster. More...
struct	_EDS_fwPostCtl
	The post context structure. More...
struct	_EDS_fwPktFree
	The LCB event free context. More...
struct	_EDS_fwLists
	Manages both the static and dynamic lists of the framework. More...
struct	_EDS_fw
	The encompassing EDS frame control structure. More...
Typedefs
typedef struct _EDS_fwMem	EDS_fwMem
	Typedef for struct _EDS_fwMem.
typedef struct _EDS_fwIxbObjDsc	EDS_fwIxbObjDsc
	Typedef for struct _EDS_fwIxbObjDsc.
typedef struct _EDS_fwIxbObjTbl	EDS_fwIxbObjTbl
	Typedef of struct _EDS_fwIxbObjTbl.
typedef struct _EDS_fwFateNeeds	EDS_fwFateNeeds
	Typedef for struct _EDS_fwFateNeeds.
typedef struct _EDS_fwSynchCtx	EDS_fwSynchCtx
	Typedef for struct _EDS_fwSynchCtx.
typedef struct _EDS_fwHandlerRegisteredServices	EDS_fwHandlerRegisteredServices
	Typedef for struct _EDS_fwHandlerRegisteredServices.
typedef struct _EDS_fwHandler	EDS_fwHandler
	Typedef for struct _EDS_fwHandler.
typedef struct _EDS_fwHandlerCfgs	EDS_fwHandlerCfgs
	Typedef for struct _EDS_fwHandlerCfgs.
typedef struct _EDS_fwPoster	EDS_fwPoster
	Typedef for struct _EDS_fwPost.
typedef struct _EDS_fwPostCtl	EDS_fwPostCtl
typedef struct _EDS_fwPktFree	EDS_fwPktFree
	Typedef for struct EDS_fwPktFree.
typedef struct _EDS_fwLists	EDS_fwLists
	Typedef for struct _EDS_fwLists.
typedef struct _EDS_fw	EDS_fw
	Typedef for struct _EDS_fw.

---

Detailed Description

The EDS framework control structure. This is private to the EDS package.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EDS_fwPvt.h,v 1.8 2011/03/25 22:16:56 russell Exp $

---

Typedef Documentation

EDS_fwHandlerCfgs

Typedef for struct _EDS_fwHandlerCfgs.

This structure is initialized when a handler is installed and updated by the EDS_fwSelect routine.

EDS_fwLists

Typedef for struct _EDS_fwLists.

Many of the actions of the framework are performed over sets and subsets of the registered callbacks. Some of these lists are static, that is they are determined during registration, and some are dynamic, that is they are constructed as the event and its possible subpackets are processed. This structure collects these list in one spot

EDS_fwMem

Typedef for struct _EDS_fwMem.

The memory allocator can be made a part of the framework routines. In general, the system allocators, malloc and free would be adequate. However, on the embedded systems, these draw from the limit system pool. This was not considered acceptable. So, the only alternative was to make the memory management available via callbacks

EDS_fwPktFree

Typedef for struct EDS_fwPktFree.

This framework is built to run with a variety of event feeders. The principle one is LCBD, but file based feeders are also used. Because of this and because the LCBD routines cannot be directly linked into these routines (they get exported to the offline world, where a real LCB is non-existent), they freeing of a packet is done via a callback.