GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LSF / V2-0-8 > lsfutils / rhel4-32
Classes | |
struct | _LSF_scanRecordHandler |
Binds a record handling routine with a context parameter. More... | |
struct | _LSF_scanContributionHandler |
Binds a contribution handling routine with a context parameter. More... | |
struct | _LSF_scanDatagramHandler |
Binds a datagram handling routine with a context parameter. More... | |
Typedefs | |
typedef enum _LSF_SCAN_STATUS_V | LSF_SCAN_STATUS_V |
Typedef for enum _LSF_SCAN_STATUS_V. | |
typedef enum _LSF_SCAN_STATUS_M | LSF_SCAN_STATUS_M |
Typedef for enum _LSF_SCAN_STATUS_M. | |
typedef unsigned int(* | LSF_scanRecordRtn )(void *ctx, const LSF_record *rec) |
Routine to handle an LSF record. | |
typedef struct _LSF_scanRecordHandler | LSF_scanRecordHandler |
Typedef of struct _LSF_scanRecordHandler. | |
typedef LSF_scanRecordHandler(* | LSF_scanContributionRtn )(void *ctx, const LSF_contribution *ctb) |
Routine to handle an LSF contribution. | |
typedef struct _LSF_scanContributionHandler | LSF_scanContributionHandler |
Typedef of struct _LSF_scanContributionHandler. | |
typedef LSF_scanContributionHandler(* | LSF_scanDatagramRtn )(void *ctx, const LSF_datagram *dgm) |
Routine to handle an LSF datagram. | |
typedef struct _LSF_scanDatagramHandler | LSF_scanDatagramHandler |
Typedef of struct _LSF_scanDatagramHandler. | |
Enumerations | |
enum | _LSF_SCAN_STATUS_V { LSF_SCAN_STATUS_V_DGM = 0x0, LSF_SCAN_STATUS_V_DGM_UNDFLW = LSF_SCAN_STATUS_V_DGM + 0, LSF_SCAN_STATUS_V_DGM_OVRFLW = LSF_SCAN_STATUS_V_DGM + 1, LSF_SCAN_STATUS_V_DGM_ROOT_UNDFLW = LSF_SCAN_STATUS_V_DGM + 2, LSF_SCAN_STATUS_V_DGM_ROOT_OVRFLW = LSF_SCAN_STATUS_V_DGM + 3, LSF_SCAN_STATUS_V_DGM_USR_ABORT = LSF_SCAN_STATUS_V_DGM + 4, LSF_SCAN_STATUS_V_CTB = 0x8, LSF_SCAN_STATUS_V_CTB_UNDFLW = LSF_SCAN_STATUS_V_CTB + 0, LSF_SCAN_STATUS_V_CTB_OVRFLW = LSF_SCAN_STATUS_V_CTB + 1, LSF_SCAN_STATUS_V_CTB_USR_ABORT = LSF_SCAN_STATUS_V_CTB + 4, LSF_SCAN_STATUS_V_REC = 0x10, LSF_SCAN_STATUS_V_REC_UNDFLW = LSF_SCAN_STATUS_V_REC + 0, LSF_SCAN_STATUS_V_REC_OVRFLW = LSF_SCAN_STATUS_V_REC + 1, LSF_SCAN_STATUS_V_REC_USR_ABORT = LSF_SCAN_STATUS_V_REC + 4 } |
Enumerates the error conditions in scan status word, right justified bit offsets. More... | |
enum | _LSF_SCAN_STATUS_M { LSF_SCAN_STATUS_M_DGM = 0xFF << LSF_SCAN_STATUS_V_DGM, LSF_SCAN_STATUS_M_DGM_UNDFLW = 1 << LSF_SCAN_STATUS_V_DGM_UNDFLW, LSF_SCAN_STATUS_M_DGM_OVRFLW = 1 << LSF_SCAN_STATUS_V_DGM_OVRFLW, LSF_SCAN_STATUS_M_DGM_ROOT_UNDFLW = 1 << LSF_SCAN_STATUS_V_DGM_ROOT_UNDFLW, LSF_SCAN_STATUS_M_DGM_ROOT_OVRFLW = 1 << LSF_SCAN_STATUS_V_DGM_ROOT_OVRFLW, LSF_SCAN_STATUS_M_DGM_USR_ABORT = 1 << LSF_SCAN_STATUS_V_DGM_USR_ABORT, LSF_SCAN_STATUS_M_CTB = 0XFF << LSF_SCAN_STATUS_V_CTB, LSF_SCAN_STATUS_M_CTB_UNDFLW = 1 << LSF_SCAN_STATUS_V_CTB_UNDFLW, LSF_SCAN_STATUS_M_CTB_OVRFLW = 1 << LSF_SCAN_STATUS_V_CTB_OVRFLW, LSF_SCAN_STATUS_M_CTB_USR_ABORT = 1 << LSF_SCAN_STATUS_V_CTB_USR_ABORT, LSF_SCAN_STATUS_M_REC = 0XFF << LSF_SCAN_STATUS_V_REC, LSF_SCAN_STATUS_M_REC_UNDFLW = 1 << LSF_SCAN_STATUS_V_REC_UNDFLW, LSF_SCAN_STATUS_M_REC_OVRFLW = 1 << LSF_SCAN_STATUS_V_REC_OVRFLW, LSF_SCAN_STATUS_M_REC_USR_ABORT = 1 << LSF_SCAN_STATUS_V_REC_USR_ABORT } |
Enumerates the error conditions in scan status word, in place mask. More... | |
Functions | |
unsigned int | LSF_scanDatagrams (const LSF_datagram *dgms, unsigned int dgms_len, LSF_scanDatagramRtn dgm_rtn, void *dgm_ctx) |
Scans through the input set of LSF datagrams. | |
unsigned int | LSF_scanContributions (const LSF_contribution *ctbs, unsigned int ctbs_len, LSF_scanContributionRtn ctb_rtn, void *ctb_ctx) |
Scans through the input LSF contributions processing each contribution. | |
unsigned int | LSF_scanRecords (const LSF_record *recs, unsigned int recs_len, LSF_scanRecordRtn rec_rtn, void *rec_ctx) |
Loops through the set of LSF records. | |
unsigned int | LSF_scanDatagram (const LSF_datagram *dgm, LSF_scanContributionRtn ctb_rtn, void *ctb_ctx) |
Scans through the input LSF datagram. | |
unsigned int | LSF_scanDatagramRoot (const LSF_datagram *dgm, LSF_scanContributionRtn ctb_rtn, void *ctb_ctx) |
Scans through the root contributions of input LSF datagram. | |
unsigned int | LSF_scanContribution (const LSF_contribution *ctb, LSF_scanRecordRtn rec_rtn, void *rec_ctx) |
Scans through the input LSF datagram. |
CVS $Id: LSF_scan.h,v 1.4 2005/11/02 17:18:20 russell Exp $
Typedef for enum _LSF_SCAN_STATUS_V.
LSF_scanRecordHandler(* LSF_scanContributionRtn)(void *ctx, const LSF_contribution *ctb) |
Routine to handle an LSF contribution.
ctx | User context parameter | |
rec | The record to handle |
LSF_scanContributionHandler(* LSF_scanDatagramRtn)(void *ctx, const LSF_datagram *dgm) |
Routine to handle an LSF datagram.
ctx | User context parameter | |
dgm | The datagram to handle |
unsigned int LSF_scanRecordRtn |
Routine to handle an LSF record.
ctx | User context parameter | |
rec | The record to handle |
enum _LSF_SCAN_STATUS_M |
Enumerates the error conditions in scan status word, in place mask.
enum _LSF_SCAN_STATUS_V |
Enumerates the error conditions in scan status word, right justified bit offsets.
unsigned int LSF_scanContribution | ( | const LSF_contribution * | ctb, | |
LSF_scanRecordRtn | rec_rtn, | |||
void * | rec_ctx | |||
) |
Scans through the input LSF datagram.
ctb | The contribution to scan | |
rec_rtn | The record level handling routine for this contribution | |
rec_ctx | The context parameter for ctb |
References _LSF_contribution::bdy, _LSF_contribution::hdr, _LSF_contribution_hdr::len32, LSF_scanRecords(), and _LSF_contribution_bdy::rec.
unsigned int LSF_scanContributions | ( | const LSF_contribution * | ctbs, | |
unsigned int | ctbs_len, | |||
LSF_scanContributionRtn | ctb_rtn, | |||
void * | ctb_ctx | |||
) |
Scans through the input LSF contributions processing each contribution.
ctbs | The first of a series of LSF contributions | |
ctbs_len | The length, in 32-bit words, of all the contributions | |
ctb_rtn | The contribution level handling routine | |
ctb_ctx | The context parameter for ctb_rtn |
References _LSF_contribution::bdy, _LSF_identity::bf, ctb_check(), _LSF_scanRecordHandler::ctx, _LSF_identity_bf::dir, _LSF_contribution::hdr, _LSF_contribution_hdr::id, _LSF_contribution_hdr::len32, LSF_contributionAdvance(), LSF_SCAN_STATUS_M_CTB, LSF_scanRecords(), _LSF_contribution_bdy::rec, and _LSF_scanRecordHandler::rtn.
Referenced by LSF_scanDatagram(), LSF_scanDatagramRoot(), and LSF_scanDatagrams().
unsigned int LSF_scanDatagram | ( | const LSF_datagram * | dgm, | |
LSF_scanContributionRtn | ctb_rtn, | |||
void * | ctb_ctx | |||
) |
Scans through the input LSF datagram.
dgm | The datagram to scan | |
ctb_rtn | The contribution level handling routine for this datagram. | |
ctb_ctx | The context parameter for ctb_rtn. |
References _LSF_datagram::bdy, _LSF_datagram_bdy::ctb, _LSF_datagram::hdr, _LSF_datagram_hdr::len32, and LSF_scanContributions().
unsigned int LSF_scanDatagramRoot | ( | const LSF_datagram * | dgm, | |
LSF_scanContributionRtn | ctb_rtn, | |||
void * | ctb_ctx | |||
) |
Scans through the root contributions of input LSF datagram.
dgm | The datagram containing the root to scan | |
ctb_rtn | The contribution level handling routine for this datagram. | |
ctb_ctx | The context parameter for ctb_rtn. |
References _LSF_root::bdy, _LSF_datagram::bdy, _LSF_root_hdr::bf, _LSF_root_bdy::ctb, _LSF_root_bdy::dat, _LSF_root::hdr, _LSF_root_hdr_bf::len32, LSF_scanContributions(), and _LSF_datagram_bdy::root.
unsigned int LSF_scanDatagrams | ( | const LSF_datagram * | dgms, | |
unsigned int | dgms_len, | |||
LSF_scanDatagramRtn | dgm_rtn, | |||
void * | dgm_ctx | |||
) |
Scans through the input set of LSF datagrams.
dgms | The first of a series of LSF datagrams | |
dgms_len | The length, in bytes, of all the datagrams | |
dgm_rtn | The datagram handling routine | |
dgm_ctx | Context parameter for dgm_rtn |
References _LSF_datagram::bdy, _LSF_root_hdr::bf, _LSF_identity::bf, _LSF_scanContributionHandler::ctx, dgm_check(), _LSF_identity_bf::dir, _LSF_root::hdr, _LSF_datagram::hdr, _LSF_datagram_hdr::id, _LSF_root_hdr_bf::len32, _LSF_datagram_hdr::len32, LSF_contributionAdvance(), LSF_datagramAdvance(), LSF_SCAN_STATUS_M_DGM, LSF_scanContributions(), _LSF_datagram_bdy::root, _LSF_identity_bf::root, root_check(), and _LSF_scanContributionHandler::rtn.
unsigned int LSF_scanRecords | ( | const LSF_record * | recs, | |
unsigned int | recs_len, | |||
LSF_scanRecordRtn | rec_rtn, | |||
void * | rec_ctx | |||
) |
Loops through the set of LSF records.
0,if | all records where processed | |
!=0,if | the scan was aborted. |
recs | The list of records to scan | |
recs_len | The length, in 32-bit units of all the records | |
rec_rtn | The record level handling routine | |
rec_ctx | The context parameter.for rec_rtn |
References _LSF_record_hdr::bf, _LSF_record::hdr, _LSF_record_hdr_bf::len32, LSF_recordAdvance(), LSF_SCAN_STATUS_M_REC, and rec_check().
Referenced by LSF_scanContribution(), and LSF_scanContributions().