GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EDS / dev > ebfio / rhel5-32
#include <EDS/LCBV.h>
#include <EDS/io/EBF_pkts.h>
Typedefs | |
typedef enum _LCBP_EDS_K | LCBP_EDS_K |
Typedef for enum _LCBP_EDS_K. | |
Enumerations | |
enum | _LCBP_EDS_K { LCBP_EDS_K_NORMAL = 0, LCBP_EDS_K_TIMED = 1 } |
Enumerates the event delivery style. More... | |
Functions | |
int | LCBP_sizeof (void) |
Returns the size, in bytes, of a virtual LCB control block. | |
void | LCBP_construct (LCBP lcb) |
Constructs (initializes) the specified virtual LCB control block. | |
LCBP | LCBP_get (void) |
Returns a pointer to the virtual LCB control block. | |
unsigned int | LCBP_create (LCBP lcb) |
Initializes the LCB virtual device control block. | |
unsigned int | LCBP_pktsConnect (LCBP lcb, EBF_pkts pkts) |
Connect a stream of packets to the virtual LCB. | |
unsigned int | LCBP_pktsDeliver (LCBP lcb) |
Feeds one packet at a time to the user provided callback routine. | |
EBF_pkts | LCBP_pktsQuery (LCBP lcb) |
Returns the current EBF_pkts. | |
unsigned int | LCBP_pktCbSet (LCBP lcb, unsigned int proto, LCBV_pktCb rtn, void *prm) |
unsigned int | LCBP_pktsRngFree (LCBP lcb, EBF_pkt *from, EBF_pkt *to) |
Dummy implementation of the corresponds LCBD routine. | |
unsigned int | LCBP_edm_configure (LCBP lcb, LCBP_EDS_K style, void *prm) |
unsigned int | LCBP_edm_reset (LCBP lcb) |
Resets the LCB handle, preparing it for a new set of data. This is generally called when switching to a new event stream. | |
unsigned int | LCBP_evt_cb_set (LCBP lcb, unsigned int proto, LCBV_pktCb rtn, void *prm) |
Establishes a callback handler for the specified protocal. | |
unsigned int | LCBP_evt_enable (LCBP lcb, int enable) |
Enables/Disables the flow of events. | |
unsigned int | LCBP_evt_handler_create (LCBP lcb, int priority) |
Creates the event que handler service task. | |
unsigned int | LCBP_evt_que_install (LCBP lcb, FORK_que *que) |
Installs queue from fcb as the task message queue for event traffic. | |
FORK_que * | LCBP_evt_que_get (LCBP lcb, int que_id) |
Installs queue from fcb as the task message queue for event traffic. |
CVS $Id: LCBP.h,v 1.7 2011/03/25 22:16:55 russell Exp $
enum _LCBP_EDS_K |
void LCBP_construct | ( | LCBP | lcb | ) |
Constructs (initializes) the specified virtual LCB control block.
lcb | The virtual LCB control block to construct |
References _LCBP::cbps, defaultCb(), _LCBP::enabled, _LCBP::init, _LCBP_pktCbp::prm, and _LCBP_pktCbp::rtn.
Referenced by fileOpen(), and LCBP_create().
unsigned int LCBP_create | ( | LCBP | lcb | ) |
Initializes the LCB virtual device control block.
lcb | The virtual LCB device handle |
References _LCBP::init, and LCBP_construct().
Referenced by EBF_streamProcess().
unsigned int LCBP_edm_reset | ( | LCBP | lcb | ) |
Resets the LCB handle, preparing it for a new set of data. This is generally called when switching to a new event stream.
lcb | The LCB control/context handle |
References _LCBP::edm, _EDM::first, _EDM::nsecx, _EDM::offset, and _EDM::prv_truncated.
Referenced by EBF_streamProcess().
int LCBP_evt_cb_set | ( | LCBP | lcb, | |
unsigned int | proto, | |||
LCBV_pktCb | rtn, | |||
void * | prm | |||
) |
Establishes a callback handler for the specified protocal.
0,Success | ||
-1,Protocal | out-of-range |
lcb | The virtual LCB device handle | |
proto | The protocol number | |
rtn | The callback routine | |
prm | Parameter to the callback routine |
References _LCBP::cbps, _LCBP_pktCbp::prm, and _LCBP_pktCbp::rtn.
Referenced by EBF_streamProcess().
int LCBP_evt_enable | ( | LCBP | lcb, | |
int | enable | |||
) |
Enables/Disables the flow of events.
0,Event | enable was not set before this call | |
1,Event | enable was set before this call | |
Anything | else, an LCBP error |
lcb | The virtual LCB device handle | |
enable | Enable (1) / Disable (0) flag |
References _LCBP::enabled.
Referenced by EBF_streamProcess().
unsigned int LCBP_evt_handler_create | ( | LCBP | lcb, | |
int | priority | |||
) |
Creates the event que handler service task.
lcb | The LCBP driver handle | |
priority | The priority of the task. If specified as -1, then a default value is assigned. |
References _LCBP_fork::fcb, _LCBP::fork, and _LCBP_fork::que.
FORK_que * LCBP_evt_que_get | ( | LCBP | lcb, | |
int | que_id | |||
) |
Installs queue from fcb as the task message queue for event traffic.
Pointer | to the fork que or NULL if non-existent |
lcb | Pointer to private LCBP structure | |
que_id | The FORK que id |
References _LCBP::fork, and _LCBP_fork::que.
unsigned int LCBP_evt_que_install | ( | LCBP | lcb, | |
FORK_que * | que | |||
) |
Installs queue from fcb as the task message queue for event traffic.
0,currently | there is no failure mode |
lcb | Pointer to private LCBP structure | |
que | The FORK que to use |
References _LCBP_fork::fcb, _LCBP::fork, and _LCBP_fork::que.
LCBP LCBP_get | ( | void | ) |
Returns a pointer to the virtual LCB control block.
Connect a stream of packets to the virtual LCB.
lcb | The virtual LCB device handle | |
pkts | The vector of packets |
References _LCBP::pkts.
Referenced by EBF_streamProcess().
unsigned int LCBP_pktsDeliver | ( | LCBP | lcb | ) |
Feeds one packet at a time to the user provided callback routine.
lcb | The virtual LCB device handle |
References LCBP_EDS_K_NORMAL, LCBP_EDS_K_TIMED, normal_delivery(), _LCBP::style, and timed_delivery().
Referenced by EBF_streamProcess().
Returns the current EBF_pkts.
lcb | The virtual LCB device handle |
References _LCBP::pkts.
Dummy implementation of the corresponds LCBD routine.
lcb | The virtual LCB device handle | |
from | The address to start the free at. | |
to | The address of the last packet to free. |
int LCBP_sizeof | ( | void | ) |
Returns the size, in bytes, of a virtual LCB control block.
Referenced by fileOpen().