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

jobid.h File Reference

L&B consumer API. More...

Go to the source code of this file.

Defines

#define EDG_WLC_JOBID_DEFAULT_PORT   9000
 Default port where bookkeeping server listens.

#define EDG_WLC_JOBID_PROTO_PREFIX   "https://"
 JobId protocol prefix.


Typedefs

typedef _edg_wlc_JobId * edg_wlc_JobId

Functions

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

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

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

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

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

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

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

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


Detailed Description

L&B consumer API.


Define Documentation

#define EDG_WLC_JOBID_DEFAULT_PORT   9000
 

Default port where bookkeeping server listens.

#define EDG_WLC_JOBID_PROTO_PREFIX   "https://"
 

JobId protocol prefix.


Typedef Documentation

typedef struct _edg_wlc_JobId* edg_wlc_JobId
 


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 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

void edg_wlc_JobIdFree edg_wlc_JobId  jobid  ) 
 

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 Wed Mar 1 00:37:55 2006 for COMMON API - configuration, jobid, ldif2classadi, logger, process, requestad, socket++i, task, utilities by doxygen 1.3.5