GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EDS / V2-10-1 > edsd / mv2304
#include "EDS/EBF_siv.h"
Classes | |
struct | _EDS_fwHandlerServicesX1 |
Event handler servicesX1. More... | |
struct | _EDS_fwHandlerServices |
Event handler services. More... | |
struct | _EDS_fwPostServices |
The services as a structure. More... | |
Typedefs | |
typedef unsigned int(* | EDS_fwHandlerObjectsGetRtn )(void *prm) |
Returns the bit mask of EDS framework objects used by this handler. | |
typedef unsigned int(* | EDS_fwHandlerNeedsGetRtn )(void *prm) |
Returns the bit mask of EDS framework needs. | |
typedef int(* | EDS_fwHandlerFlushRtn )(void *prm, int reason) |
typedef unsigned int(* | EDS_fwHandlerProcessRtn )(void *prm, unsigned int pktBytes, EBF_pkt *pkt, EBF_siv siv, EDS_fwIxb *ixb, int id) |
The event handler. | |
typedef unsigned int(* | EDS_fwHandlerSelectRtn )(void *ctl, unsigned int mode, EDS_cfgInfo *cfg) |
Signature for a routine to select the handler mode. | |
typedef unsigned int(* | EDS_fwHandlerStartRtn )(void *ctl, unsigned int reason, unsigned int run_id, unsigned int start_time, unsigned int mode) |
Signature for a routine to select the handler mode. | |
typedef unsigned int(* | EDS_fwHandlerAssociateRtn )(void *ctl, unsigned int mode, unsigned int cfg) |
Signature for a routine to associate handler modes. | |
typedef int(* | EDS_fwHandlerResultSizeofRtn )(void *prm) |
Callback signature of a to be the size, in bytes, of a handler's result summary vector. | |
typedef int(* | EDS_fwHandlerDestructRtn )(void *prm) |
Callback signature of a registered handler's destruction routine. | |
typedef struct _EDS_fwHandlerServicesX1 | EDS_fwHandlerServicesX1 |
Typedef for struct _EDS_fwHandlerServicesX1. | |
typedef struct _EDS_fwHandlerServices | EDS_fwHandlerServices |
Typedef for struct _EDS_fwHandlerServices. | |
typedef int(* | EDS_fwPostStartRtn )(void *prm, int reason, unsigned int run_id, unsigned int startTime, unsigned int mode, unsigned int hw_key, unsigned int cfg_key) |
Callback signature to start or prepare a posting stream to receive events. | |
typedef void(* | EDS_fwPostWriteRtn )(void *prm, EDS_fwIxb *ixb) |
Callback signature to write an event to the post stream. | |
typedef int(* | EDS_fwPostNotifyRtn )(void *prm, unsigned int mode, unsigned int active, const EDS_cfgInfo cfgs[32], const EDS_rsdTbl *rsdTbl) |
Routine to notify clients of a change in the handlers' configuration. | |
typedef int(* | EDS_fwPostFlushRtn )(void *prm, int reason) |
Callback signature for the event post que flushing routine. | |
typedef struct _EDS_fwPostServices | EDS_fwPostServices |
Typedef for EDS_fwPostServices. |
CVS $Id: EDS_fwServices.h,v 1.7 2007/10/10 18:09:59 russell Exp $
unsigned int(* EDS_fwHandlerAssociateRtn)(void *ctl, unsigned int mode, unsigned int cfg) |
Signature for a routine to associate handler modes.
ctl | The control context for this handler | |
mode | The target mode. It is this mode that the new configuration is associated with. Currently this number must be between 0 and 7 inclusive. | |
cfg | The id of the new configuration. Currently this number must be between 0 and 31 inclusive. |
associate (ctl, TOO, CONFIGURATION_2) set (ctl, TOO);
int(* EDS_fwHandlerDestructRtn)(void *prm) |
Callback signature of a registered handler's destruction routine.
prm | The arbitrary user parameter associated with the handler |
unsigned int(* EDS_fwHandlerNeedsGetRtn)(void *prm) |
Returns the bit mask of EDS framework needs.
prm | The arbitrary user parameter associated with the handler |
unsigned int(* EDS_fwHandlerObjectsGetRtn)(void *prm) |
Returns the bit mask of EDS framework objects used by this handler.
prm | The arbitrary user parameter associated with the handler |
unsigned int(* EDS_fwHandlerProcessRtn)(void *prm, unsigned int pktBytes, EBF_pkt *pkt, EBF_siv siv, EDS_fwIxb *ixb, int id) |
The event handler.
prm | Arbitrary user parameter | |
pktBytes | The number of bytes in this packet | |
pkt | The packet itself | |
siv | The state information vector | |
ixb | The Information Exchange Block | |
id | The identity (0-31) of this handler. This can be used to index various arrays, In particular, the array of result descriptors in the Ixb Result Vector table |
int(* EDS_fwHandlerResultSizeofRtn)(void *prm) |
Callback signature of a to be the size, in bytes, of a handler's result summary vector.
prm | The arbitrary user parameter associated with the handler |
unsigned int(* EDS_fwHandlerSelectRtn)(void *ctl, unsigned int mode, EDS_cfgInfo *cfg) |
Signature for a routine to select the handler mode.
==0 | Success | |
!=0 | Failure |
ctl | The control context for this handler | |
mode | The new mode. Currently this number must be between 0 and 7 inclusive. | |
cfg | Filled in by the called with information about the newly selected configuration. |
Typedef for struct _EDS_fwHandlerServices.
These are deemed outside the scope to the EDS framework.
Typedef for struct _EDS_fwHandlerServicesX1.
These are deemed outside the scope to the EDS framework.
unsigned int(* EDS_fwHandlerStartRtn)(void *ctl, unsigned int reason, unsigned int run_id, unsigned int start_time, unsigned int mode) |
Signature for a routine to select the handler mode.
ctl | The control context for this handler | |
reason | Suggested use is to indicate why the post stream is being started | |
run_id | Suggested use is to identify the block of events between when EDS_fwStart is called and EDS_fwFlush is called with a stop reason | |
startTime | The run start time rounded to the nearest second | |
mode | This must be the running mode. Note that a call to EDS_selectMode still must be done. |
int(* EDS_fwPostFlushRtn)(void *prm, int reason) |
Callback signature for the event post que flushing routine.
Status 0, success, anything else failure
prm | Arbitrary user parameter | |
list | The list of post ques to flush | |
reason | The reason for flushing the ques |
int(* EDS_fwPostNotifyRtn)(void *prm, unsigned int mode, unsigned int active, const EDS_cfgInfo cfgs[32], const EDS_rsdTbl *rsdTbl) |
Routine to notify clients of a change in the handlers' configuration.
prm | Arbitrary user parameter | |
mode | The new mode | |
active | List of the currently active handlers | |
cfgs | The array of configurations, indexed by handler number | |
rsdTbl | The table of result summary data table |
int(* EDS_fwPostStartRtn)(void *prm, int reason, unsigned int run_id, unsigned itn startTime, unsigned int mode, unsigned int hw_key, unsigned int cfg_key) |
Callback signature to start or prepare a posting stream to receive events.
prm | Arbitrary user parameter | |
reason | Suggested use is to indicate why the post stream is being started | |
run_id | Suggested use is to identify the block of events between when EDS_fwStart is called and EDS_fwFlush is called with a stop reason | |
startTime | The run start time rounded to the nearest second | |
mode | This must be the running mode. | |
hw_key | The hardware configuration file key | |
cfg_key | The software configuration file key. This likely a reference to how event handlers to EDS here configured (perhaps the LPA_DB key). |
void(* EDS_fwPostWriteRtn)(void *prm, EDS_fwIxb *ixb) |
Callback signature to write an event to the post stream.
prm | Arbitrary user parameter | |
ixb | The framework's Information Exchange Block |