vtkSocketController Class Reference

Process communication using Sockets. More...

#include <vtkSocketController.h>

Inheritance diagram for vtkSocketController:

Collaboration diagram for vtkSocketController:

Public Types
enum	Consts { ENDIAN_TAG = 1010580540 , IDTYPESIZE_TAG = 1027423549 , VERSION_TAG = 1044266558 , HASH_TAG = 0x3f3f3f3f }
typedef vtkMultiProcessController	Superclass
Public Types inherited from vtkMultiProcessController
enum	Errors { RMI_NO_ERROR , RMI_TAG_ERROR , RMI_ARG_ERROR }
enum	Consts { ANY_SOURCE = -1 , INVALID_SOURCE = -2 }
enum	Tags { RMI_TAG = 1 , RMI_ARG_TAG = 2 , BREAK_RMI_TAG = 3 , XML_WRITER_DATA_INFO = 4 }
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSocketController *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Initialize (int *argc, char ***argv, int) override
	This method is for initialiazing sockets.
void	Initialize (int *argc, char ***argv) override
virtual void	Initialize ()
void	Finalize () override
	Does not apply to sockets.
void	Finalize (int) override
	This method is for cleaning up.
void	SingleMethodExecute () override
	Does not apply to sockets.
void	MultipleMethodExecute () override
	Does not apply to sockets.
void	CreateOutputWindow () override
	Does not apply to sockets.
virtual int	WaitForConnection (int port)
	Wait for connection on a given port, forwarded to the communicator.
virtual void	CloseConnection ()
	Close a connection, forwarded to the communicator.
virtual int	ConnectTo (const char *hostName, int port)
	Open a connection to a give machine, forwarded to the communicator.
int	GetSwapBytesInReceivedData ()
void	SetCommunicator (vtkSocketCommunicator *comm)
	Set the communicator used in normal and rmi communications.
vtkMultiProcessController *	CreateCompliantController ()
	FOOLISH MORTALS! Thou hast forsaken the sacred laws of ad-hoc polymorphism when thou broke a critical assumption of the superclass (namely, each process has thine own id).
Public Member Functions inherited from vtkMultiProcessController
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkMultiProcessController *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv))=0
	This method is for setting up the processes.
virtual void	Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv), int initializedExternally)=0
	This method is for setting up the processes.
virtual void	Finalize ()=0
	This method is for cleaning up.
virtual void	Finalize (int finalizedExternally)=0
	This method is for cleaning up.
void	SetSingleMethod (vtkProcessFunctionType, void *data)
	Set the SingleMethod to f() and the UserData of the for the method to be executed by all of the processes when SingleMethodExecute is called.
void	SetSingleProcessObject (vtkProcess *p)
	Object-oriented flavor of SetSingleMethod().
virtual void	SingleMethodExecute ()=0
	Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes.
void	SetMultipleMethod (int index, vtkProcessFunctionType, void *data)
	Set the MultipleMethod to f() and the UserData of the for the method to be executed by the process index when MultipleMethodExecute is called.
virtual void	MultipleMethodExecute ()=0
	Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.
int	GetLocalProcessId ()
	Tells you which process [0, NumProcess) you are in.
virtual void	CreateOutputWindow ()=0
	This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id.
virtual vtkMultiProcessController *	CreateSubController (vtkProcessGroup *group)
	Creates a new controller with the processes specified by the given group.
virtual vtkMultiProcessController *	PartitionController (int localColor, int localKey)
	Partitions this controller based on a coloring.
virtual unsigned long	AddRMI (vtkRMIFunctionType, void *localArg, int tag)
	Register remote method invocation in the receiving process which makes the call.
virtual int	RemoveFirstRMI (int tag)
	Remove the first RMI matching the tag.
virtual int	RemoveRMI (unsigned long id)
	Remove the RMI matching the id.
virtual void	RemoveRMI (vtkRMIFunctionType f, void *arg, int tag)
	Take an RMI away.
virtual unsigned long	AddRMICallback (vtkRMIFunctionType, void *localArg, int tag)
	These methods are a part of the newer API to add multiple rmi callbacks.
virtual void	RemoveAllRMICallbacks (int tag)
	These methods are a part of the newer API to add multiple rmi callbacks.
virtual bool	RemoveRMICallback (unsigned long id)
	Remove a callback.
void	TriggerRMI (int remoteProcessId, void *arg, int argLength, int tag)
	A method to trigger a method invocation in another process.
void	TriggerBreakRMIs ()
	A convenience method.
void	TriggerRMI (int remoteProcessId, const char *arg, int tag)
	Convenience method when the arg is a string.
void	TriggerRMI (int remoteProcessId, int tag)
	Convenience method when there is no argument.
void	Barrier ()
	This method can be used to synchronize processes.
int	Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
	Send a stream to another process.
int	Receive (vtkMultiProcessStream &stream, int remoteId, int tag)
	Receive a stream from the other processes.
vtkDataObject *	ReceiveDataObject (int remoteId, int tag)
vtkIdType	GetCount ()
	Returns the number of words received by the most recent Receive().
int	Broadcast (vtkMultiProcessStream &stream, int srcProcessId)
int	Gather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer, int destProcessId)
	Gathers vtkDataObject (sendBuffer) from all ranks to the destProcessId.
int	Gather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer, int destProcessId)
	Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId.
int	GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int	GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdTypeArray *recvLengths, vtkIdTypeArray *offsets, int destProcessId)
int	AllGather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer)
	Gathers vtkDataObject (sendBuffer) from all ranks to all raks.
int	AllGather (const vtkMultiProcessStream &sendBuffer, std::vector< vtkMultiProcessStream > &recvBuffer)
	Gathers vtkMultiProcessStream (sendBuffer) from all ranks to the destProcessId.
int	AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
	This special form of AllGatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order.
int	AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int	AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation)
virtual bool	CanProbe ()
	Check if this controller implements a probe operation.
virtual int	Probe (int source, int tag, int *actualSource)
	Blocking test for checking for a message tagged with tag from source process (if source == ANY_SOURCE check for any message).
void	SetNumberOfProcesses (int num)
	Set the number of processes you will be using.
int	GetNumberOfProcesses ()
	Set the number of processes you will be using.
void	TriggerRMIOnAllChildren (void *arg, int argLength, int tag)
	This is a convenicence method to trigger an RMI call on all the "children" of the current node.
void	TriggerRMIOnAllChildren (const char *arg, int tag)
	This is a convenicence method to trigger an RMI call on all the "children" of the current node.
void	TriggerRMIOnAllChildren (int tag)
	This is a convenicence method to trigger an RMI call on all the "children" of the current node.
void	BroadcastTriggerRMIOnAllChildren (void *arg, int argLength, int tag)
	This is a convenicence method to trigger an RMI call on all the "children" of the current node.
int	ProcessRMIs (int reportErrors, int dont_loop=0)
	Calling this method gives control to the controller to start processing RMIs.
int	ProcessRMIs ()
	Calling this method gives control to the controller to start processing RMIs.
int	BroadcastProcessRMIs (int reportErrors, int dont_loop=0)
	Calling this method gives control to the controller to start processing RMIs.
virtual void	SetBreakFlag (int)
	Setting this flag to 1 will cause the ProcessRMIs loop to return.
virtual int	GetBreakFlag ()
	Setting this flag to 1 will cause the ProcessRMIs loop to return.
virtual void	SetBroadcastTriggerRMI (bool)
	Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites.
virtual bool	GetBroadcastTriggerRMI ()
	Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites.
virtual void	BroadcastTriggerRMIOn ()
	Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites.
virtual void	BroadcastTriggerRMIOff ()
	Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the satellites.
virtual vtkCommunicator *	GetCommunicator ()
	Returns the communicator associated with this controller.
int	Send (const int *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const short *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const unsigned short *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const unsigned int *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const unsigned long *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const long *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const signed char *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const char *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const unsigned char *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const float *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const double *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const long long *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (const unsigned long long *data, vtkIdType length, int remoteProcessId, int tag)
	This method sends data to another process.
int	Send (vtkDataObject *data, int remoteId, int tag)
	This method sends data to another process.
int	Send (vtkDataArray *data, int remoteId, int tag)
	This method sends data to another process.
int	Receive (int *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (unsigned int *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (short *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (unsigned short *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (long *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (unsigned long *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (char *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (unsigned char *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (signed char *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (float *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (double *data, vtkIdType maxlength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (unsigned long long *data, vtkIdType maxLength, int remoteProcessId, int tag)
	This method receives data from a corresponding send.
int	Receive (vtkDataObject *data, int remoteId, int tag)
	This method receives data from a corresponding send.
int	Receive (vtkDataArray *data, int remoteId, int tag)
	This method receives data from a corresponding send.
int	Broadcast (int *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (unsigned int *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (short *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (unsigned short *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (unsigned long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (unsigned char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (signed char *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (float *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (double *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (long long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (unsigned long long *data, vtkIdType length, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (vtkDataObject *data, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Broadcast (vtkDataArray *data, int srcProcessId)
	Broadcast sends the array in the process with id srcProcessId to all of the other processes.
int	Gather (const int *sendBuffer, int *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const short *sendBuffer, short *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const long *sendBuffer, long *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const char *sendBuffer, char *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
	Gather collects arrays in the process with id destProcessId.
int	GatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
	GatherV is the vector variant of Gather.
int	GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
	This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order.
int	GatherV (vtkDataObject *sendData, vtkSmartPointer< vtkDataObject > *recvData, int destProcessId)
	This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order.
int	Scatter (const int *sendBuffer, int *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const short *sendBuffer, short *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const long *sendBuffer, long *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const char *sendBuffer, char *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const double *sendBuffer, double *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	Scatter (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int srcProcessId)
	Scatter takes an array in the process with id srcProcessId and distributes it.
int	ScatterV (const int *sendBuffer, int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const short *sendBuffer, short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const long *sendBuffer, long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const char *sendBuffer, char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const float *sendBuffer, float *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const double *sendBuffer, double *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const long long *sendBuffer, long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	ScatterV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
	ScatterV is the vector variant of Scatter.
int	AllGather (const int *sendBuffer, int *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const short *sendBuffer, short *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const long *sendBuffer, long *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const char *sendBuffer, char *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const float *sendBuffer, float *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length)
	Same as gather except that the result ends up on all processes.
int	AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
	Same as gather except that the result ends up on all processes.
int	AllGatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets)
	Same as GatherV except that the result is placed in all processes.
int	Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation, int destProcessId)
	Reduce an array to the given destination process.
int	AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
	Same as Reduce except that the result is placed in all of the processes.
int	Reduce (const vtkBoundingBox &sendBuffer, vtkBoundingBox &recvBuffer, int destProcessId)
	Convenience methods to reduce bounds.
int	AllReduce (const vtkBoundingBox &sendBuffer, vtkBoundingBox &recvBuffer)
	Convenience methods to reduce bounds.
int	Reduce (vtkDataArraySelection *sendBuffer, vtkDataArraySelection *recvBuffer, int destProcessId)
	Convenience methods to reduce vtkDataArraySelection.
int	AllReduce (vtkDataArraySelection *sendBuffer, vtkDataArraySelection *recvBuffer)
	Convenience methods to reduce vtkDataArraySelection.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkSocketController *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSocketController *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkMultiProcessController
static vtkTypeBool	IsTypeOf (const char *type)
static vtkMultiProcessController *	SafeDownCast (vtkObjectBase *o)
static vtkMultiProcessController *	GetGlobalController ()
	This convenience method returns the controller associated with the local process.
static int	GetBreakRMITag ()
	Accessor to some default tags.
static int	GetRMITag ()
static int	GetRMIArgTag ()
static void	SetGlobalController (vtkMultiProcessController *controller)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSocketController ()
	~vtkSocketController () override
Protected Member Functions inherited from vtkMultiProcessController
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMultiProcessController ()
	~vtkMultiProcessController () override
virtual void	TriggerRMIInternal (int remoteProcessId, void *arg, int argLength, int rmiTag, bool propagate)
	Implementation for TriggerRMI() provides subclasses an opportunity to modify the behaviour eg.
void	GetMultipleMethod (int index, vtkProcessFunctionType &func, void *&data)
void	ProcessRMI (int remoteProcessId, void *arg, int argLength, int rmiTag)
virtual vtkMultiProcessController *	GetLocalController ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Attributes
static int	Initialized

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkMultiProcessController
vtkProcessFunctionType	SingleMethod
void *	SingleData
int	BreakFlag
int	ForceDeepCopy
bool	BroadcastTriggerRMI
vtkOutputWindow *	OutputWindow
vtkCommunicator *	Communicator
vtkCommunicator *	RMICommunicator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Process communication using Sockets.

This is a concrete implementation of vtkMultiProcessController. It supports one-to-one communication using sockets. Note that process 0 will always correspond to self and process 1 to the remote process. This class is best used with ports.

Bug:

Note that because process 0 will always correspond to self, this class breaks assumptions usually implied when using ad-hoc polymorphism. That is, the vtkSocketController will behave differently than other subclasses of vtkMultiProcessController. If you upcast vtkSocketController to vtkMultiProcessController and send it to a method that does not know that the object is actually a vtkSocketController, the object may not behave as intended. For example, if that oblivious class chose to identify a "root" based on the local process id, then both sides of the controller will think they are the root (and that will probably lead to deadlock). If you plan to upcast to vtkMultiProcessController, you should probably use the CreateCompliantController instead.

See also

vtkMultiProcessController vtkSocketCommunicator vtkInputPort vtkOutputPort

Tests:

vtkSocketController (Tests)

Definition at line 41 of file vtkSocketController.h.

Member Typedef Documentation

Superclass

typedef vtkMultiProcessController vtkSocketController::Superclass

Definition at line 45 of file vtkSocketController.h.

Member Enumeration Documentation

Consts

enum vtkSocketController::Consts

Enumerator
ENDIAN_TAG
IDTYPESIZE_TAG
VERSION_TAG
HASH_TAG

Definition at line 113 of file vtkSocketController.h.

Constructor & Destructor Documentation

vtkSocketController()

vtkSocketController::vtkSocketController ( )

protected

~vtkSocketController()

vtkSocketController::~vtkSocketController ( )

overrideprotected

Member Function Documentation

New()

static vtkSocketController * vtkSocketController::New ( )

static

IsTypeOf()

static vtkTypeBool vtkSocketController::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkSocketController::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMultiProcessController.

SafeDownCast()

static vtkSocketController * vtkSocketController::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSocketController::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiProcessController.

NewInstance()

vtkSocketController * vtkSocketController::NewInstance

(

)

const

PrintSelf()

void vtkSocketController::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkMultiProcessController.

Initialize() [1/3]

void vtkSocketController::Initialize ( int *  argc, char ***  argv, int    )

inlineoverride

This method is for initialiazing sockets.

One of these is REQUIRED for Windows.

Definition at line 52 of file vtkSocketController.h.

Initialize() [2/3]

void vtkSocketController::Initialize ( int *  argc, char ***  argv  )

override

Initialize() [3/3]

virtual void vtkSocketController::Initialize ( )

inlinevirtual

Definition at line 54 of file vtkSocketController.h.

Finalize() [1/2]

void vtkSocketController::Finalize ( )

inlineoverridevirtual

Does not apply to sockets.

Does nothing.

Implements vtkMultiProcessController.

Definition at line 59 of file vtkSocketController.h.

Finalize() [2/2]

void vtkSocketController::Finalize ( int  finalizedExternally )

inlineoverridevirtual

This method is for cleaning up.

If a subclass needs to clean up process communication (i.e. MPI) it would over ride this method. Provided for finalization outside vtk.

Implements vtkMultiProcessController.

Definition at line 60 of file vtkSocketController.h.

SingleMethodExecute()

void vtkSocketController::SingleMethodExecute ( )

inlineoverridevirtual

Does not apply to sockets.

Does nothing.

Implements vtkMultiProcessController.

Definition at line 65 of file vtkSocketController.h.

MultipleMethodExecute()

void vtkSocketController::MultipleMethodExecute ( )

inlineoverridevirtual

Does not apply to sockets.

Does nothing.

Implements vtkMultiProcessController.

Definition at line 70 of file vtkSocketController.h.

CreateOutputWindow()

void vtkSocketController::CreateOutputWindow ( )

inlineoverridevirtual

Does not apply to sockets.

Does nothing.

Implements vtkMultiProcessController.

Definition at line 75 of file vtkSocketController.h.

WaitForConnection()

virtual int vtkSocketController::WaitForConnection ( int  port )

virtual

Wait for connection on a given port, forwarded to the communicator.

CloseConnection()

virtual void vtkSocketController::CloseConnection ( )

virtual

Close a connection, forwarded to the communicator.

ConnectTo()

virtual int vtkSocketController::ConnectTo ( const char *  hostName, int  port  )

virtual

Open a connection to a give machine, forwarded to the communicator.

GetSwapBytesInReceivedData()

int vtkSocketController::GetSwapBytesInReceivedData

(

)

SetCommunicator()

void vtkSocketController::SetCommunicator

(

vtkSocketCommunicator *

comm

)

Set the communicator used in normal and rmi communications.

CreateCompliantController()

vtkMultiProcessController * vtkSocketController::CreateCompliantController

(

)

FOOLISH MORTALS! Thou hast forsaken the sacred laws of ad-hoc polymorphism when thou broke a critical assumption of the superclass (namely, each process has thine own id).

The time frame to fix thy error has passed. Too much code has come to rely on this abhorrent behavior. Instead, we offer this gift: a method for creating an equivalent communicator with correct process id semantics. The calling code is responsible for deleting this controller.

Member Data Documentation

Initialized

int vtkSocketController::Initialized

staticprotected

Definition at line 126 of file vtkSocketController.h.

---

The documentation for this class was generated from the following file:

• Parallel/Core/vtkSocketController.h