Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

jobid.h File Reference

L&B consumer API. More...

Go to the source code of this file.

Functions

int edg_wlc_JobIdCreate (const char *bkserver, int port, edg_wlc_JobId *jobid)
 Create a Job ID. More...

int edg_wlc_JobIdRecreate (const char *bkserver, int port, const char *unique, edg_wlc_JobId *jobid)
 Recreate a Job ID. More...

int edg_wlc_JobIdDup (const edg_wlc_JobId in, edg_wlc_JobId *jobid)
 Create copy of Job ID. More...

int edg_wlc_JobIdParse (const char *jobidstr, edg_wlc_JobId *jobid)
 Parse Job ID string and creates jobid structure. More...

char * edg_wlc_JobIdUnparse (const edg_wlc_JobId jobid)
 Unparse Job ID (produce the string form of JobId). More...

char * edg_wlc_JobIdGetServer (const edg_wlc_JobId jobid)
 Extract bookkeeping server address (address:port). More...

void edg_wlc_JobIdGetServerParts (const edg_wlc_JobId jobid, char **srvName, unsigned int *srvPort)
 Extract bookkeeping server address and port. More...

char * edg_wlc_JobIdGetUnique (const edg_wlc_JobId jobid)
 Extract unique string. More...


Detailed Description

L&B consumer API.


Function Documentation

int edg_wlc_JobIdCreate const char *    bkserver,
int    port,
edg_wlc_JobId *    jobid
 

Create a Job ID.

See the lb_draft document for details on its construction and components

Parameters:
bkserver  book keeping server hostname
port  port for the bk service
jobid  new created job id \ret al 0 success
Return values:
EINVAL  invalid bkserver
ENOMEM  if memory allocation fails

int edg_wlc_JobIdDup const edg_wlc_JobId    in,
edg_wlc_JobId *    jobid
 

Create copy of Job ID.

Parameters:
in  jobid for duplication
jobid  duplicated jobid
Return values:
0  for success
EINVAL  invalid jobid
ENOMEM  if memory allocation fails

char* edg_wlc_JobIdGetServer const edg_wlc_JobId    jobid
 

Extract bookkeeping server address (address:port).

Parameters:
jobid  from which the bkserver address should be extracted
Return values:
pointer  to allocated string with bkserver address
NULL  if jobid is 0 or memory allocation fails

void edg_wlc_JobIdGetServerParts const edg_wlc_JobId    jobid,
char **    srvName,
unsigned int *    srvPort
 

Extract bookkeeping server address and port.

Parameters:
jobid  from which the bkserver address should be extracted
srvName  pointer where to return server name
srvPort  pointer where to return server port

char* edg_wlc_JobIdGetUnique const edg_wlc_JobId    jobid
 

Extract unique string.

Parameters:
jobid 
Return values:
pointer  to allocated unique string representing jobid
NULL  if jobid is 0 or memory allocation fails

int edg_wlc_JobIdParse const char *    jobidstr,
edg_wlc_JobId *    jobid
 

Parse Job ID string and creates jobid structure.

Parameters:
jobidstr  string representation of jobid
jobid  parsed job id
Return values:
0  for success
EINVAL  jobidstr can't be parsed
ENOMEM  if memory allocation fails

int edg_wlc_JobIdRecreate const char *    bkserver,
int    port,
const char *    unique,
edg_wlc_JobId *    jobid
 

Recreate a Job ID.

Parameters:
bkserver  bookkeeping server hostname
port  port for the bk service
unique  string which represent created jobid (if NULL then new one is created)
jobid  new created job id
Return values:
0  success
EINVAL  invalid bkserver
ENOMEM  if memory allocation fails

char* edg_wlc_JobIdUnparse const edg_wlc_JobId    jobid
 

Unparse Job ID (produce the string form of JobId).

Parameters:
jobid  to be converted to string
Returns:
allocated string which represents jobid


Generated on Fri May 14 14:18:26 2004 for COMMON API - configuration, jobid, ldif2classadi, logger, process, requestad, socket++i, task, utilities by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002