ScaleViz/libImports/ScClusterCom.h File Reference

Go to the source code of this file.

Defines
#define	CLUSTERCOM_API
Typedefs
typedef struct ScClusterCommunicator	ScClusterCom
Functions
CLUSTERCOM_API ScClusterCom *	ScClusterCom_Init (int *argc, char ***argv, void *unused, int size)
CLUSTERCOM_API void	ScClusterCom_Finish (ScClusterCom *)
CLUSTERCOM_API int	ScClusterCom_getNodeID (ScClusterCom *)
CLUSTERCOM_API int	ScClusterCom_getNbNode (ScClusterCom *)
CLUSTERCOM_API void	ScClusterCom_Barrier (ScClusterCom *)
CLUSTERCOM_API int	ScClusterCom_Broadcast (ScClusterCom *, int rootID, void *buffer, int size)
CLUSTERCOM_API int	ScClusterCom_Exchange (ScClusterCom *, void *snd_buffer, int snd_size, int sndID, void *rcv_buffer, int rcv_size, int rcvID)
CLUSTERCOM_API const char *	ScClusterCom_ErrString (const int error)

---

Define Documentation

#define CLUSTERCOM_API

---

Typedef Documentation

typedef struct ScClusterCommunicator ScClusterCom

---

Function Documentation

CLUSTERCOM_API void ScClusterCom_Barrier

(

ScClusterCom *

)

Forces all nodes to reach this before continuing.

CLUSTERCOM_API int ScClusterCom_Broadcast	(	ScClusterCom *	,
		int	rootID,
		void *	buffer,
		int	size
	)

Initiates a broadcast operation from the rootID node to all other nodes.

Returns -1 on error.

CLUSTERCOM_API const char* ScClusterCom_ErrString

(

const int

error

)

Converts an error into a human readable string.

CLUSTERCOM_API int ScClusterCom_Exchange	(	ScClusterCom *	,
		void *	snd_buffer,
		int	snd_size,
		int	sndID,
		void *	rcv_buffer,
		int	rcv_size,
		int	rcvID
	)

Initiates a buffer exchange communication (i.e., like MPI_SendRecv).

CLUSTERCOM_API void ScClusterCom_Finish

(

ScClusterCom *

)

Closes and destroys a previously allocated Cluster Communicator.

CLUSTERCOM_API int ScClusterCom_getNbNode

(

ScClusterCom *

)

Gets the number of nodes in the cluster.

Returns -1 on error.

CLUSTERCOM_API int ScClusterCom_getNodeID

(

ScClusterCom *

)

Gets the rank of the caller in the global cluster.

Return a value in the range [0..nbnode-1] on success. Returns -1 on error.

CLUSTERCOM_API ScClusterCom* ScClusterCom_Init	(	int *	argc,
		char ***	argv,
		void *	unused,
		int	size
	)

Allocates and initializes a new Cluster Communicator.

Returns NULL if error.