GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > FMX / V3-3-1

Constituent: fmxshr     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » SYS » source » FMX » V3-3-1 » FMX

FMX_pubdefs.h File Reference

Public definitions for the ITC package. More...

This graph shows which files directly or indirectly include this file:


Defines

#define FMX_L_ENUM_TABLES   (6)
 Number of enumeration tables FMX recognizes.

Typedefs

typedef _FMX_Connection FMX_Connection
 Typedef for struct _FMX_Connection.
typedef enum _FMX_EnumTableList FMX_EnumTableList
 Typedef for enum _FMX_EnumTableList.
typedef enum _FMX_FileGroup FMX_FileGroup
 Typedef for enum _FMX_FileGroup.
typedef unsigned int FMX_cb_scanFilesByKey (void *prm, unsigned int key, const char *dir, FMX_FileGroup group, unsigned int flight, unsigned int visible, const char *tag, unsigned int index, unsigned int size, const char *date, const char *name)
 Signature for a FMX_scanFilesByKey callback function.
typedef unsigned int FMX_cb_scanFOFmembers (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name)
 Signature for a FMX_scanFOFmembers callback function.
typedef unsigned int FMX_cb_scanSBSmembers (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name, const char *pkg, const char *ver, const char *con)
 Signature for a FMX_scanSBSmembers callback function.

Enumerations

enum  _FMX_EnumTableList {
  FMX_ENUM_TABLE_DEVICE = 0,
  FMX_ENUM_TABLE_FILETYPE = 1,
  FMX_ENUM_TABLE_HOST = 2,
  FMX_ENUM_TABLE_INSTRUMENT = 3,
  FMX_ENUM_TABLE_NODE = 4,
  FMX_ENUM_TABLE_TAG = 5
}
 Enumeration of enumeration tables FMX recognizes (!). More...
enum  _FMX_FileGroup {
  FMX_GRP_UNKNOWN = -1,
  FMX_GRP_SIMPLE = 0,
  FMX_GRP_COMPOUND = 1,
  FMX_GRP_MODULE = 2
}
 Enumeration of the groups filetypes can belong to. More...

Functions

unsigned int FMX_connect (FMX_Connection **con, const char *host, const char *user, const char *pass, int port)
 Create a connection to the database.
unsigned int FMX_disconnect (FMX_Connection *ucb)
 Break a connection to the database.
unsigned int FMX_findCDMbyKey (FMX_Connection *ucb, unsigned int key, const char *tag, unsigned int absolute, char *nambuf, unsigned int bufmax, unsigned int *namlen)
 Return the filename of a CDM file corresponding to key.
unsigned int FMX_initialize (void)
 Initialize the FMX client.
unsigned int FMX_scanFilesByKey (FMX_Connection *ucb, unsigned int key, FMX_cb_scanFilesByKey *rtn, void *prm)
 Scan all files with logical key key.
unsigned int FMX_scanFOFmembers (FMX_Connection *ucb, unsigned int key, unsigned int flight, FMX_cb_scanFOFmembers *rtn, void *prm)
 Scan the members of a "file-of-files" compounf file.
unsigned int FMX_scanSBSmembers (FMX_Connection *ucb, unsigned int key, const char *tag, unsigned int flight, FMX_cb_scanSBSmembers *rtn, void *prm)
 Scan the members of a secondary boot script.
void FMX_shutdown (void)
 Shut down the FMX client.

Detailed Description

Public definitions for the ITC package. 

CVS $Id: FMX_pubdefs.h,v 1.3 2007/04/19 21:36:10 apw Exp $
Author:
A.P.Waite

Enumeration Type Documentation

enum _FMX_EnumTableList
 

Enumeration of enumeration tables FMX recognizes (!).

Enumerator:
FMX_ENUM_TABLE_DEVICE  Device table
FMX_ENUM_TABLE_FILETYPE  Filetype table
FMX_ENUM_TABLE_HOST  Host table
FMX_ENUM_TABLE_INSTRUMENT  Instrument table
FMX_ENUM_TABLE_NODE  Node table
FMX_ENUM_TABLE_TAG  Tag table

enum _FMX_FileGroup
 

Enumeration of the groups filetypes can belong to.

Enumerator:
FMX_GRP_UNKNOWN  Unknown filetype membership
FMX_GRP_SIMPLE  Member of group "simple"
FMX_GRP_COMPOUND  Member of group "compound"
FMX_GRP_MODULE  Member of group "module"

Function Documentation

unsigned int FMX_connect (  FMX_Connection **  con,
const char *  host,
const char *  user,
const char *  pass,
int  port
) 
 

Create a connection to the database.

Parameters:
con (out) Connection handle
host (in) Host name (NULL: take from $FMX_C_FDB)
user (in) User name (NULL: take from .my.cnf)
pass (in) Password (NULL: take from .my.cnf)
port (in) Connection handle
Return values:
FMX_ALLOCBUF Local (stack) buffer too small
FMX_ALLOCMEM Cannot allocate sufficient memory (dynamic)
FMX_EVMISS Expected environment variable not found
FMX_MYSQLCON Cannot select database status from global table
FMX_LINKMIST Expected file system link not found
FMX_MYCNFBAD User's .my.cnf file insufficiently protected
FMX_MYCNFMIS Cannot find user's .my.cnf file
FMX_MYSQLINT Cannot initialize a MySQL handle
FMX_MYSQLCON Cannot connect to MySQL database
FMX_SUCCESS Success
FMX_USERACC Cannot determine access privileges for user
FMX_USERID Cannot identify user from database tables
FMX_USERNOT User has no privileges on this database

unsigned int FMX_disconnect (  FMX_Connection *  ucb  ) 
 

Break a connection to the database.

Parameters:
ucb (in) User connection block
Return values:
FMX_UCBMISS Connection block not found in list
FMX_UCBNOT Invalid connection block
FMX_SUCCESS Success

unsigned int FMX_findCDMbyKey (  FMX_Connection *  ucb,
unsigned int  key,
const char *  tag,
unsigned int  absolute,
char *  nambuf,
unsigned int  bufmax,
unsigned int *  namlen
) 
 

Return the filename of a CDM file corresponding to key.

Parameters:
ucb (in) Database connection handle
key (in) Logical file key to scan
tag (in) Architecture tag name
absolute (in) Request absolute file name
nambuf (in) Buffer into which to place the file name
bufmax (in) Length of nambuf
namlen (in) Actual length of file name
Return values:
FMX_NULLPNTR NULL pointer
FMX_SUCCESS Success
FMX_TAGTYPE Unknown architecture (tag) type
FMX_UCBNOT Invalid connection block

unsigned int FMX_initialize (  void   ) 
 

Initialize the FMX client.

Return values:
FMX_FCBINIT FMX control block already initialized
FMX_ALLOCMEM Cannot allocate memory for FMX control block
FMX_SUCCESS Success

unsigned int FMX_scanFilesByKey (  FMX_Connection *  ucb,
unsigned int  key,
FMX_cb_scanFilesByKey *  rtn,
void *  prm
) 
 

Scan all files with logical key key.

Parameters:
ucb (in) Database connection handle
key (in) Logical file key to scan
rtn (in) Callback routine
prm (in) Callback routine parameter
Return values:
FMX_ALLOCMEM Cannot allocate sufficient memory (dynamic)
FMX_FILEGRP Unrecognized file group
FMX_KEYNOT Invalid logical file key
FMX_SUCCESS Success
FMX_TAGMISS Unknown tag type (database inconsistency?)
FMX_UCBNOT Invalid connection block

unsigned int FMX_scanFOFmembers (  FMX_Connection *  ucb,
unsigned int  key,
unsigned int  flight,
FMX_cb_scanFOFmembers *  rtn,
void *  prm
) 
 

Scan the members of a "file-of-files" compounf file.

Parameters:
ucb (in) Database connection handle
key (in) Resolved file key for the "file-of-files"
flight (in) Scan the ground/flight files (boolean)
rtn (in) Callback routine
prm (in) Callback routine parameter
Return values:
FMX_ALLOCMEM Cannot allocate sufficient memory (dynamic)
FMX_FILEGRP Unrecognized file group
FMX_KEYNOT Invalid logical file key
FMX_SUCCESS Success
FMX_TAGMISS Unknown tag type (database inconsistency?)
FMX_UCBNOT Invalid connection block

unsigned int FMX_scanSBSmembers (  FMX_Connection *  ucb,
unsigned int  key,
const char *  tag,
unsigned int  flight,
FMX_cb_scanSBSmembers *  rtn,
void *  prm
) 
 

Scan the members of a secondary boot script.

Parameters:
ucb (in) Database connection handle
key (in) Resolved file key for the secondary boot script
tag (in) Architecture tag name for which to resolve files
flight (in) Scan the ground/flight files (boolean)
rtn (in) Callback routine
prm (in) Callback routine parameter
Return values:
FMX_ALLOCMEM Cannot allocate sufficient memory (dynamic)
FMX_FILEGRP Unrecognized file group
FMX_KEYNOT Invalid logical file key
FMX_SUCCESS Success
FMX_TAGMISS Unknown tag type (database inconsistency?)
FMX_UCBNOT Invalid connection block

void FMX_shutdown (  void   ) 
 

Shut down the FMX client.

Return values:
FMX_SUCCESS Success

Generated on Sat May 26 03:36:21 2007 by  doxygen 1.4.4