Main Page   Compound List   File List   Compound Members   File Members  

consumer.h File Reference

L&B consumer API. More...

Go to the source code of this file.

Compounds

struct  _edg_wll_QueryRec

Server querying

#define EDG_WLL_STAT_CLASSADS   1 /**< various job description fields */
 Bitmasks for edg_wll_JobStatus() flags argument. More...

int edg_wll_QueryEvents (edg_wll_Context context, const edg_wll_QueryRec *job_conditions, const edg_wll_QueryRec *event_conditions, edg_wll_Event **events)
 General query on events. More...

int edg_wll_QueryJobs (edg_wll_Context context, const edg_wll_QueryRec *conditions, int flags, edg_wlc_JobId **jobs, edg_wll_JobStat **states)
 General query on jobs. More...


Typedefs

typedef enum _edg_wll_QueryAttr edg_wll_QueryAttr
typedef enum _edg_wll_QueryOp edg_wll_QueryOp
typedef _edg_wll_QueryRec edg_wll_QueryRec

Enumerations

enum  _edg_wll_QueryAttr {
  EDG_WLL_QUERY_ATTR_UNDEF = 0, EDG_WLL_QUERY_ATTR_JOBID, EDG_WLL_QUERY_ATTR_OWNER, EDG_WLL_QUERY_ATTR_STATUS,
  EDG_WLL_QUERY_ATTR_LOCATION, EDG_WLL_QUERY_ATTR_DESTINATION, EDG_WLL_QUERY_ATTR_DONECODE, EDG_WLL_QUERY_ATTR_USERTAG,
  EDG_WLL_QUERY_ATTR_TIME, EDG_WLL_QUERY_ATTR_LEVEL, EDG_WLL_QUERY_ATTR_HOST, EDG_WLL_QUERY_ATTR_SOURCE,
  EDG_WLL_QUERY_ATTR_INSTANCE, EDG_WLL_QUERY_ATTR_EVENT_TYPE, EDG_WLL_QUERY_ATTR_CHKPT_TAG, EDG_WLL_QUERY_ATTR_RESUBMITTED,
  EDG_WLL_QUERY_ATTR_PARENT, EDG_WLL_QUERY_ATTR_EXITCODE
}
enum  _edg_wll_QueryOp { EDG_WLL_QUERY_OP_EQUAL, EDG_WLL_QUERY_OP_LESS, EDG_WLL_QUERY_OP_GREATER, EDG_WLL_QUERY_OP_WITHIN }


Detailed Description

L&B consumer API.

(lbapi.h originaly)

General rules:


Define Documentation

#define EDG_WLL_STAT_CLASSADS   1 /**< various job description fields */
 

Bitmasks for edg_wll_JobStatus() flags argument.

Settings these flags causes the status calls to retrieve additional information.


Typedef Documentation

typedef enum _edg_wll_QueryAttr edg_wll_QueryAttr
 

Predefined types for query attributes

typedef enum _edg_wll_QueryOp edg_wll_QueryOp
 

Predefined types for query operands

typedef struct _edg_wll_QueryRec edg_wll_QueryRec
 

Single query condition for edg_wll_Query(). Those records are composed to form an SQL where clause when processed at the L&B server


Enumeration Type Documentation

enum _edg_wll_QueryAttr
 

Predefined types for query attributes

Enumeration values:
EDG_WLL_QUERY_ATTR_UNDEF  Not-defined value, used to terminate lists etc.
EDG_WLL_QUERY_ATTR_JOBID  Job Id.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_ATTR_OWNER  Job owner.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_ATTR_STATUS  Current job status.
EDG_WLL_QUERY_ATTR_LOCATION  Where is the job processed.
EDG_WLL_QUERY_ATTR_DESTINATION  Destination CE.
EDG_WLL_QUERY_ATTR_DONECODE  Minor done status (OK,fail,cancel).
EDG_WLL_QUERY_ATTR_USERTAG  User tag (not implemented yet).
EDG_WLL_QUERY_ATTR_TIME  Timestamp.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_ATTR_LEVEL  Logging level (see "dglog.h") *.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_ATTR_HOST  Where the event was generated.
EDG_WLL_QUERY_ATTR_SOURCE  Source component.
EDG_WLL_QUERY_ATTR_INSTANCE  Instance of the source component.
EDG_WLL_QUERY_ATTR_EVENT_TYPE  Event type.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_ATTR_CHKPT_TAG  Checkpoint tag.
EDG_WLL_QUERY_ATTR_RESUBMITTED  Job was resubmitted.
EDG_WLL_QUERY_ATTR_PARENT  Job was resubmitted.
EDG_WLL_QUERY_ATTR_EXITCODE  Unix exit code.

enum _edg_wll_QueryOp
 

Predefined types for query operands

Enumeration values:
EDG_WLL_QUERY_OP_EQUAL  attribute is equal to the operand value.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_OP_LESS  attribute is grater than the operand value.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_OP_GREATER  attribute is less than the operand value.

See also:
_edg_wll_QueryRec
EDG_WLL_QUERY_OP_WITHIN  attribute is in given interval.

See also:
_edg_wll_QueryRec


Function Documentation

int edg_wll_QueryEvents edg_wll_Context    context,
const edg_wll_QueryRec   job_conditions,
const edg_wll_QueryRec   event_conditions,
edg_wll_Event **    events
 

General query on events.

Return events satysfying all conditions query records represent conditions in the form attr op value eg. time > 87654321.

See also:
edg_wll_QueryRec
Parameters:
context  IN: context to work with
job_conditions  IN: query conditions (ANDed) on current job status, null (i.e. ATTR_UNDEF) terminated list. NULL means empty list, i.e. always TRUE
event_conditions:  conditions on events, null terminated list, NULL means empty list, i.e. always TRUE
events  OUT: list of matching events

int edg_wll_QueryJobs edg_wll_Context    context,
const edg_wll_QueryRec   conditions,
int    flags,
edg_wlc_JobId **    jobs,
edg_wll_JobStat **    states
 

General query on jobs.

Return jobs (and possibly their states) for which an event satisfying the conditions exists.

See also:
edg_wll_QueryEvents
Parameters:
context  IN: context to work with
conditions  IN: query records (ANDed), null (i.e. EDG_WLL_ATTR_UNDEF) terminated list
flags  IN: additional status fields to retrieve (
See also:
edg_wll_JobStatus)
Parameters:
jobs  OUT: list of job ids. May be NULL.
states  OUT: list of corresponding states (returned only if not NULL)


Generated on Fri May 14 14:18:56 2004 for L&B API C by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002