dnxCollector.h File Reference

#include "dnxJobList.h"
#include "dnxTransport.h"

Go to the source code of this file.

Data Structures

struct  DnxCollector
 Abstract data type for the DNX job results collector. More...

Functions

DnxChanneldnxCollectorGetChannel (DnxCollector *coll)
 Return a reference to the collector channel object.
int dnxCollectorCreate (char *chname, char *collurl, DnxJobList *joblist, DnxCollector **pcoll)
 Create a new collector object.
void dnxCollectorDestroy (DnxCollector *coll)
 Destroy an existing collector object.


Function Documentation

int dnxCollectorCreate ( char *  chname,
char *  collurl,
DnxJobList joblist,
DnxCollector **  pcoll 
)

Create a new collector object.

Parameters:
[in] chname - the name of the collect channel.
[in] collurl - the collect channel URL.
[in] joblist - a pointer to the global job list object.
[out] pcoll - the address of storage for the return of the new collector object.
Returns:
Zero on success, or a non-zero error value.

Definition at line 133 of file dnxCollector.c.

void dnxCollectorDestroy ( DnxCollector coll  ) 

Destroy an existing collector object.

Parameters:
[in] coll - a pointer to the collector object to be destroyed.

Definition at line 190 of file dnxCollector.c.

DnxChannel* dnxCollectorGetChannel ( DnxCollector coll  ) 

Return a reference to the collector channel object.

Parameters:
[in] coll - the collector whose dispatch channel should be returned.
Returns:
A pointer to the collector channel object.

Definition at line 128 of file dnxCollector.c.


Generated on Tue Apr 13 15:15:30 2010 for DNX by  doxygen 1.5.6