dnxRegistrar.h File Reference

#include "dnxQueue.h"
#include "dnxTransport.h"
#include "dnxProtocol.h"

Go to the source code of this file.

Data Structures
struct	DnxRegistrar
	An abstraction data type for the DNX registrar object. More...
Functions
int	dnxGetNodeRequest (DnxRegistrar *reg, DnxNodeRequest **ppNode)
	Return an available node "request for work" object pointer.
int	dnxRegistrarCreate (unsigned queuesz, DnxChannel *dispchan, DnxRegistrar **preg)
	Create a new registrar object.
void	dnxRegistrarDestroy (DnxRegistrar *reg)
	Destroy a previously created registrar object.

---

Function Documentation

int dnxGetNodeRequest	(	DnxRegistrar *	reg,
		DnxNodeRequest **	ppNode
	)

Return an available node "request for work" object pointer.

Parameters:

[in]	reg	- the registrar from which a node request should be returned.
[out]	ppNode	- the address of storage in which to return the located request node.

Returns:

Zero on success, or a non-zero error value.

Definition at line 236 of file dnxRegistrar.c.

int dnxRegistrarCreate	(	unsigned	queuesz,
		DnxChannel *	dispchan,
		DnxRegistrar **	preg
	)

Create a new registrar object.

Parameters:

[in]	queuesz	- the size of the queue to create in this registrar.
[in]	dispchan	- a pointer to the dispatcher channel.
[out]	preg	- the address of storage in which to return the newly created registrar.

Returns:

Zero on success, or a non-zero error value.

Definition at line 285 of file dnxRegistrar.c.

void dnxRegistrarDestroy

(

DnxRegistrar *

reg

)

Destroy a previously created registrar object.

Signals the registrar thread, waits for it to stop, and frees allocated resources.

Parameters:

[in]

reg

- the registrar to be destroyed.

Definition at line 318 of file dnxRegistrar.c.