dnxSrvProt.h File Reference

Types and definitions for DNX server-side messaging protocol. More...

#include "dnxProtocol.h"

Go to the source code of this file.

Functions
int	dnxWaitForResult (DnxChannel *channel, DnxResult *pResult, char *address, int timeout)
	Collect job results from a client (server).
int	dnxSendJob (DnxChannel *channel, DnxJob *pJob, char *address)
	Dispatch a job to a client node (server).
int	dnxWaitForNodeRequest (DnxChannel *channel, DnxNodeRequest *pReg, char *address, int timeout)
	Wait for a node request (server).

---

Detailed Description

Types and definitions for DNX server-side messaging protocol.

Author:

Robert W. Ingraham (dnx-devel@lists.sourceforge.net)

Attention:

Please submit patches to http://dnx.sourceforge.net

Definition in file dnxSrvProt.h.

---

Function Documentation

int dnxSendJob	(	DnxChannel *	channel,
		DnxJob *	pJob,
		char *	address
	)

Dispatch a job to a client node (server).

Parameters:

[in]	channel	- the channel on which to send pJob.
[in]	pJob	- the job request to be sent on channel.
[in]	address	- the address to which pJob should be sent. This parameter is optional, and may be specified as NULL, in which case the channel address will be used.

Returns:

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

Definition at line 48 of file dnxSrvProt.c.

int dnxWaitForNodeRequest	(	DnxChannel *	channel,
		DnxNodeRequest *	pReg,
		char *	address,
		int	timeout
	)

Wait for a node request (server).

Parameters:

[in]	channel	- the channel from which to receive the node request.
[out]	pReg	- the address of storage into which the request should be read from channel.
[out]	address	- the address of storage in which to return the address of the sender. This parameter is optional and may be passed as NULL. If non-NULL, it should be large enough to store sockaddr_* data.
[in]	timeout	- the maximum number of seconds the caller is willing to wait before accepting a timeout error.

Returns:

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

Definition at line 85 of file dnxSrvProt.c.

int dnxWaitForResult	(	DnxChannel *	channel,
		DnxResult *	pResult,
		char *	address,
		int	timeout
	)

Collect job results from a client (server).

Parameters:

[in]	channel	- the channel from which to receive the job result.
[out]	pResult	- the address of storage into which the job result should be read from channel.
[out]	address	- the address of storage in which to return the address of the sender. This parameter is optional and may be passed as NULL. If non-NULL, it should be large enough to store sockaddr_* data.
[in]	timeout	- the maximum number of seconds the caller is willing to wait before accepting a timeout error.

Returns:

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

Definition at line 147 of file dnxSrvProt.c.