VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSocketCommunicator Class Reference

Process communication using Sockets. More...

#include <vtkSocketCommunicator.h>

Inheritance diagram for vtkSocketCommunicator:
[legend]
Collaboration diagram for vtkSocketCommunicator:
[legend]

Public Types

typedef vtkCommunicator Superclass
 
- Public Types inherited from vtkCommunicator
enum  Tags {
  BROADCAST_TAG = 10, GATHER_TAG = 11, GATHERV_TAG = 12, SCATTER_TAG = 13,
  SCATTERV_TAG = 14, REDUCE_TAG = 15, BARRIER_TAG = 16
}
 
enum  StandardOperations {
  MAX_OP, MIN_OP, SUM_OP, PRODUCT_OP,
  LOGICAL_AND_OP, BITWISE_AND_OP, LOGICAL_OR_OP, BITWISE_OR_OP,
  LOGICAL_XOR_OP, BITWISE_XOR_OP
}
 
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. More...
 
vtkSocketCommunicatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int WaitForConnection (int port)
 Wait for connection on a given port. More...
 
virtual int WaitForConnection (vtkServerSocket *socket, unsigned long msec=0)
 
virtual void CloseConnection ()
 Close a connection. More...
 
virtual int ConnectTo (const char *hostName, int port)
 Open a connection to host. More...
 
virtual int GetSwapBytesInReceivedData ()
 Returns 1 if bytes must be swapped in received ints, floats, etc. More...
 
int GetIsConnected ()
 Is the communicator connected?. More...
 
void SetNumberOfProcesses (int num) override
 Set the number of processes you will be using. More...
 
int SendVoidArray (const void *data, vtkIdType length, int type, int remoteHandle, int tag) override
 Performs the actual communication. More...
 
int ReceiveVoidArray (void *data, vtkIdType length, int type, int remoteHandle, int tag) override
 Subclasses have to supply this method to receive various arrays of data. More...
 
void Barrier () override
 This class foolishly breaks the conventions of the superclass, so this overload fixes the method. More...
 
int BroadcastVoidArray (void *data, vtkIdType length, int type, int srcProcessId) override
 This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work. More...
 
int GatherVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int destProcessId) override
 
int GatherVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type, int destProcessId) override
 
int ScatterVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int srcProcessId) override
 
int ScatterVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int type, int srcProcessId) override
 
int AllGatherVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type) override
 
int AllGatherVVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int type) override
 
int ReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation, int destProcessId) override
 
int ReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation, int destProcessId) override
 
int AllReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, int operation) override
 
int AllReduceVoidArray (const void *sendBuffer, void *recvBuffer, vtkIdType length, int type, Operation *operation) override
 
virtual void SetPerformHandshake (vtkTypeBool)
 Set or get the PerformHandshake ivar. More...
 
virtual void PerformHandshakeOn ()
 
virtual void PerformHandshakeOff ()
 
virtual vtkTypeBool GetPerformHandshake ()
 
virtual void SetLogStream (ostream *stream)
 Get/Set the output stream to which communications should be logged. More...
 
virtual ostream * GetLogStream ()
 
virtual int LogToFile (const char *name)
 Log messages to the given file. More...
 
virtual int LogToFile (const char *name, int append)
 
virtual void SetReportErrors (int)
 If ReportErrors if false, all vtkErrorMacros are suppressed. More...
 
virtual int GetReportErrors ()
 
virtual vtkClientSocketGetSocket ()
 Get/Set the actual socket used for communication. More...
 
void SetSocket (vtkClientSocket *)
 
int Handshake ()
 Performs handshake. More...
 
int ServerSideHandshake ()
 Performs ServerSide handshake. More...
 
int ClientSideHandshake ()
 Performs ClientSide handshake. More...
 
virtual int GetIsServer ()
 Returns true if this side of the socket is the server. More...
 
void BufferCurrentMessage ()
 This flag is cleared before vtkCommand::WrongTagEvent is fired when ever a message with mismatched tag is received. More...
 
bool HasBufferredMessages ()
 Returns true if there are any messages in the receive buffer. More...
 
- Public Member Functions inherited from vtkCommunicator
vtkCommunicatorNewInstance () const
 
virtual int GetNumberOfProcesses ()
 
virtual int GetLocalProcessId ()
 Tells you which process [0, NumProcess) you are in. More...
 
int Send (vtkDataObject *data, int remoteHandle, int tag)
 This method sends a data object to a destination. More...
 
int Send (vtkDataArray *data, int remoteHandle, int tag)
 This method sends a data array to a destination. More...
 
int Send (const int *data, vtkIdType length, int remoteHandle, int tag)
 Convenience methods for sending data arrays. More...
 
int Send (const unsigned int *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const short *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const unsigned short *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const long *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const unsigned long *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const unsigned char *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const char *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const signed char *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const float *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const double *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const long long *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const unsigned long long *data, vtkIdType length, int remoteHandle, int tag)
 
int Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
 
int Receive (vtkDataObject *data, int remoteHandle, int tag)
 This method receives a data object from a corresponding send. More...
 
vtkDataObjectReceiveDataObject (int remoteHandle, int tag)
 The caller does not have to know the data type before this call is made. More...
 
int Receive (vtkDataArray *data, int remoteHandle, int tag)
 This method receives a data array from a corresponding send. More...
 
int Receive (int *data, vtkIdType maxlength, int remoteHandle, int tag)
 Convenience methods for receiving data arrays. More...
 
int Receive (unsigned int *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (short *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (unsigned short *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (long *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (unsigned long *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (unsigned char *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (char *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (signed char *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (float *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (double *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (long long *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (unsigned long long *data, vtkIdType maxlength, int remoteHandle, int tag)
 
int Receive (vtkMultiProcessStream &stream, int remoteId, int tag)
 
virtual vtkIdType GetCount ()
 Returns the number of words received by the most recent Receive(). More...
 
int Broadcast (int *data, vtkIdType length, int srcProcessId)
 Broadcast sends the array in the process with id srcProcessId to all of the other processes. More...
 
int Broadcast (unsigned int *data, vtkIdType length, int srcProcessId)
 
int Broadcast (short *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned short *data, vtkIdType length, int srcProcessId)
 
int Broadcast (long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (signed char *data, vtkIdType length, int srcProcessId)
 
int Broadcast (float *data, vtkIdType length, int srcProcessId)
 
int Broadcast (double *data, vtkIdType length, int srcProcessId)
 
int Broadcast (long long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (unsigned long long *data, vtkIdType length, int srcProcessId)
 
int Broadcast (vtkDataObject *data, int srcProcessId)
 
int Broadcast (vtkDataArray *data, int srcProcessId)
 
int Broadcast (vtkMultiProcessStream &stream, int srcProcessId)
 
int Gather (const int *sendBuffer, int *recvBuffer, vtkIdType length, int destProcessId)
 Gather collects arrays in the process with id destProcessId. More...
 
int Gather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const short *sendBuffer, short *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const long *sendBuffer, long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const char *sendBuffer, char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int destProcessId)
 
int Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
 
int Gather (vtkDataObject *sendBuffer, std::vector< vtkSmartPointer< vtkDataObject > > &recvBuffer, int destProcessId)
 Gathers vtkDataObject (sendBuffer) from all ranks to the destProcessId. More...
 
int GatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 GatherV is the vector variant of Gather. More...
 
int GatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
 For the first GatherV variant, recvLengths and offsets known on destProcessId and are passed in as parameters For the second GatherV variant, recvLengths and offsets are not known on destProcessId. More...
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdTypeArray *recvLengths, vtkIdTypeArray *offsets, int destProcessId)
 
int GatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
 
int GatherV (vtkDataObject *sendData, vtkSmartPointer< vtkDataObject > *recvData, int destProcessId)
 Collects data objects in the process with id destProcessId. More...
 
int Scatter (const int *sendBuffer, int *recvBuffer, vtkIdType length, int srcProcessId)
 Scatter takes an array in the process with id srcProcessId and distributes it. More...
 
int Scatter (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const short *sendBuffer, short *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const long *sendBuffer, long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const char *sendBuffer, char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const double *sendBuffer, double *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int srcProcessId)
 
int Scatter (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int srcProcessId)
 
int ScatterV (const int *sendBuffer, int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 ScatterV is the vector variant of Scatter. More...
 
int ScatterV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const short *sendBuffer, short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const long *sendBuffer, long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const char *sendBuffer, char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const float *sendBuffer, float *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const double *sendBuffer, double *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const long long *sendBuffer, long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int ScatterV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
 
int AllGather (const int *sendBuffer, int *recvBuffer, vtkIdType length)
 Same as gather except that the result ends up on all processes. More...
 
int AllGather (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length)
 
int AllGather (const short *sendBuffer, short *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length)
 
int AllGather (const long *sendBuffer, long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length)
 
int AllGather (const char *sendBuffer, char *recvBuffer, vtkIdType length)
 
int AllGather (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length)
 
int AllGather (const float *sendBuffer, float *recvBuffer, vtkIdType length)
 
int AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
 
int AllGather (const long long *sendBuffer, long long *recvBuffer, vtkIdType length)
 
int AllGather (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length)
 
int AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
 
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. More...
 
int AllGatherV (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const short *sendBuffer, short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const long *sendBuffer, long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const long long *sendBuffer, long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkIdType *recvLengths, vtkIdType *offsets)
 
int AllGatherV (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
 
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation, int destProcessId)
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
 
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 Reduce an array to the given destination process. More...
 
int Reduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, Operation *operation, int destProcessId)
 
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, Operation *operation, int destProcessId)
 
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. More...
 
int AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, int operation)
 
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
 
int AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const unsigned int *sendBuffer, unsigned int *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const short *sendBuffer, short *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const unsigned short *sendBuffer, unsigned short *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const long *sendBuffer, long *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const signed char *sendBuffer, signed char *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const long long *sendBuffer, long long *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (const unsigned long long *sendBuffer, unsigned long long *recvBuffer, vtkIdType length, Operation *operation)
 
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, Operation *operation)
 
virtual int ComputeGlobalBounds (int processorId, int numProcesses, vtkBoundingBox *bounds, int *rightHasBounds=nullptr, int *leftHasBounds=nullptr, int hasBoundsTag=288402, int localBoundsTag=288403, int globalBoundsTag=288404)
 Determine the global bounds for a set of processes. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSocketCommunicatorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSocketCommunicatorSafeDownCast (vtkObjectBase *o)
 
static int GetVersion ()
 Uniquely identifies the version of this class. More...
 
- Static Public Member Functions inherited from vtkCommunicator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCommunicatorSafeDownCast (vtkObjectBase *o)
 
static void SetUseCopy (int useCopy)
 
static int GetParentProcessor (int pid)
 Some helper functions when dealing with heap tree - based algorithms - we don't need a function for getting the right processor since it is 1 + theLeftProcessor. More...
 
static int GetLeftChildProcessor (int pid)
 
static int MarshalDataObject (vtkDataObject *object, vtkCharArray *buffer)
 Convert a data object into a string that can be transmitted and vice versa. More...
 
static int UnMarshalDataObject (vtkCharArray *buffer, vtkDataObject *object)
 
static vtkSmartPointer< vtkDataObjectUnMarshalDataObject (vtkCharArray *buffer)
 Same as UnMarshalDataObject(vtkCharArray*, vtkDataObject*) except that this method doesn't need to know the type of the data object a priori. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSocketCommunicator ()
 
 ~vtkSocketCommunicator () override
 
int SendTagged (const void *data, int wordSize, int numWords, int tag, const char *logName)
 
int ReceiveTagged (void *data, int wordSize, int numWords, int tag, const char *logName)
 
int ReceivePartialTagged (void *data, int wordSize, int numWords, int tag, const char *logName)
 
int ReceivedTaggedFromBuffer (void *data, int wordSize, int numWords, int tag, const char *logName)
 
void FixByteOrder (void *data, int wordSize, int numWords)
 Fix byte order for received data. More...
 
void LogTagged (const char *name, const void *data, int wordSize, int numWords, int tag, const char *logName)
 
int CheckForErrorInternal (int id)
 
- Protected Member Functions inherited from vtkCommunicator
int WriteDataArray (vtkDataArray *object)
 
int ReadDataArray (vtkDataArray *object)
 
 vtkCommunicator ()
 
 ~vtkCommunicator () override
 
int SendElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)
 
int GatherV (vtkDataArray *sendArray, vtkDataArray *recvArray, vtkSmartPointer< vtkDataArray > *recvArrays, int destProcessId)
 GatherV collects arrays in the process with id destProcessId. More...
 
int GatherVElementalDataObject (vtkDataObject *sendData, vtkSmartPointer< vtkDataObject > *receiveData, int destProcessId)
 
int ReceiveDataObject (vtkDataObject *data, int remoteHandle, int tag, int type=-1)
 
int ReceiveElementalDataObject (vtkDataObject *data, int remoteHandle, int tag)
 
int ReceiveMultiBlockDataSet (vtkMultiBlockDataSet *data, int remoteHandle, int tag)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkClientSocketSocket
 
int SwapBytesInReceivedData
 
int RemoteHas64BitIds
 
vtkTypeBool PerformHandshake
 
int IsServer
 
int ReportErrors
 
ofstream * LogFile
 
ostream * LogStream
 
bool BufferMessage
 
- Protected Attributes inherited from vtkCommunicator
int MaximumNumberOfProcesses
 
int NumberOfProcesses
 
int LocalProcessId
 
vtkIdType Count
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Attributes inherited from vtkCommunicator
static int UseCopy
 

Detailed Description

Process communication using Sockets.

This is a concrete implementation of vtkCommunicator which supports interprocess communication using BSD style sockets. It supports byte swapping for the communication of machines with different endianness.

Warning
Communication between 32 bit and 64 bit systems is not fully supported. If a type does not have the same length on both systems, this communicator can not be used to transfer data of that type.
See also
vtkCommunicator vtkSocketController
Tests:
vtkSocketCommunicator (Tests)

Definition at line 60 of file vtkSocketCommunicator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkSocketCommunicator.h.

Constructor & Destructor Documentation

◆ vtkSocketCommunicator()

vtkSocketCommunicator::vtkSocketCommunicator ( )
protected

◆ ~vtkSocketCommunicator()

vtkSocketCommunicator::~vtkSocketCommunicator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSocketCommunicator* vtkSocketCommunicator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSocketCommunicator::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 vtkCommunicator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSocketCommunicator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCommunicator.

◆ NewInstance()

vtkSocketCommunicator* vtkSocketCommunicator::NewInstance ( ) const

◆ PrintSelf()

void vtkSocketCommunicator::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 vtkCommunicator.

◆ WaitForConnection() [1/2]

virtual int vtkSocketCommunicator::WaitForConnection ( int  port)
virtual

Wait for connection on a given port.

These methods return 1 on success, 0 on error.

◆ WaitForConnection() [2/2]

virtual int vtkSocketCommunicator::WaitForConnection ( vtkServerSocket socket,
unsigned long  msec = 0 
)
virtual

◆ CloseConnection()

virtual void vtkSocketCommunicator::CloseConnection ( )
virtual

Close a connection.

◆ ConnectTo()

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

Open a connection to host.

◆ GetSwapBytesInReceivedData()

virtual int vtkSocketCommunicator::GetSwapBytesInReceivedData ( )
virtual

Returns 1 if bytes must be swapped in received ints, floats, etc.

◆ GetIsConnected()

int vtkSocketCommunicator::GetIsConnected ( )

Is the communicator connected?.

◆ SetNumberOfProcesses()

void vtkSocketCommunicator::SetNumberOfProcesses ( int  num)
overridevirtual

Set the number of processes you will be using.

Reimplemented from vtkCommunicator.

◆ SendVoidArray()

int vtkSocketCommunicator::SendVoidArray ( const void *  data,
vtkIdType  length,
int  type,
int  remoteHandle,
int  tag 
)
overridevirtual

Performs the actual communication.

You will usually use the convenience Send functions defined in the superclass.

Implements vtkCommunicator.

◆ ReceiveVoidArray()

int vtkSocketCommunicator::ReceiveVoidArray ( void *  data,
vtkIdType  maxlength,
int  type,
int  remoteHandle,
int  tag 
)
overridevirtual

Subclasses have to supply this method to receive various arrays of data.

The type arg is one of the VTK type constants recognized by the vtkTemplateMacro (VTK_FLOAT, VTK_INT, etc.). maxlength is measured in number of values (as opposed to number of bytes) and is the maxmum length of the data to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Implements vtkCommunicator.

◆ Barrier()

void vtkSocketCommunicator::Barrier ( )
overridevirtual

This class foolishly breaks the conventions of the superclass, so this overload fixes the method.

Reimplemented from vtkCommunicator.

◆ BroadcastVoidArray()

int vtkSocketCommunicator::BroadcastVoidArray ( void *  data,
vtkIdType  length,
int  type,
int  srcProcessId 
)
overridevirtual

This class foolishly breaks the conventions of the superclass, so the default implementations of these methods do not work.

These just give errors instead.

Reimplemented from vtkCommunicator.

◆ GatherVoidArray()

int vtkSocketCommunicator::GatherVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  destProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ GatherVVoidArray()

int vtkSocketCommunicator::GatherVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  type,
int  destProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ ScatterVoidArray()

int vtkSocketCommunicator::ScatterVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  srcProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ ScatterVVoidArray()

int vtkSocketCommunicator::ScatterVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType sendLengths,
vtkIdType offsets,
vtkIdType  recvLength,
int  type,
int  srcProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ AllGatherVoidArray()

int vtkSocketCommunicator::AllGatherVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ AllGatherVVoidArray()

int vtkSocketCommunicator::AllGatherVVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  sendLength,
vtkIdType recvLengths,
vtkIdType offsets,
int  type 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ ReduceVoidArray() [1/2]

int vtkSocketCommunicator::ReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  operation,
int  destProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ ReduceVoidArray() [2/2]

int vtkSocketCommunicator::ReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
Operation operation,
int  destProcessId 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ AllReduceVoidArray() [1/2]

int vtkSocketCommunicator::AllReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
int  operation 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ AllReduceVoidArray() [2/2]

int vtkSocketCommunicator::AllReduceVoidArray ( const void *  sendBuffer,
void *  recvBuffer,
vtkIdType  length,
int  type,
Operation operation 
)
overridevirtual

Reimplemented from vtkCommunicator.

◆ SetPerformHandshake()

virtual void vtkSocketCommunicator::SetPerformHandshake ( vtkTypeBool  )
virtual

Set or get the PerformHandshake ivar.

If it is on, the communicator will try to perform a handshake when connected. It is on by default.

◆ PerformHandshakeOn()

virtual void vtkSocketCommunicator::PerformHandshakeOn ( )
virtual

◆ PerformHandshakeOff()

virtual void vtkSocketCommunicator::PerformHandshakeOff ( )
virtual

◆ GetPerformHandshake()

virtual vtkTypeBool vtkSocketCommunicator::GetPerformHandshake ( )
virtual

◆ SetLogStream()

virtual void vtkSocketCommunicator::SetLogStream ( ostream *  stream)
virtual

Get/Set the output stream to which communications should be logged.

This is intended as a debugging feature.

◆ GetLogStream()

virtual ostream* vtkSocketCommunicator::GetLogStream ( )
virtual

◆ LogToFile() [1/2]

virtual int vtkSocketCommunicator::LogToFile ( const char *  name)
virtual

Log messages to the given file.

The file is truncated unless the second argument is non-zero (default is to truncate). If the file name is empty or nullptr, logging is disabled. Returns 0 if the file failed to open, and 1 otherwise.

◆ LogToFile() [2/2]

virtual int vtkSocketCommunicator::LogToFile ( const char *  name,
int  append 
)
virtual

◆ SetReportErrors()

virtual void vtkSocketCommunicator::SetReportErrors ( int  )
virtual

If ReportErrors if false, all vtkErrorMacros are suppressed.

◆ GetReportErrors()

virtual int vtkSocketCommunicator::GetReportErrors ( )
virtual

◆ GetSocket()

virtual vtkClientSocket* vtkSocketCommunicator::GetSocket ( )
virtual

Get/Set the actual socket used for communication.

◆ SetSocket()

void vtkSocketCommunicator::SetSocket ( vtkClientSocket )

◆ Handshake()

int vtkSocketCommunicator::Handshake ( )

Performs handshake.

This uses vtkClientSocket::ConnectingSide to decide whether to perform ServerSideHandshake or ClientSideHandshake.

◆ ServerSideHandshake()

int vtkSocketCommunicator::ServerSideHandshake ( )

Performs ServerSide handshake.

One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.

◆ ClientSideHandshake()

int vtkSocketCommunicator::ClientSideHandshake ( )

Performs ClientSide handshake.

One should preferably use Handshake() which calls ServerSideHandshake or ClientSideHandshake as required.

◆ GetIsServer()

virtual int vtkSocketCommunicator::GetIsServer ( )
virtual

Returns true if this side of the socket is the server.

The result is invalid if the socket is not connected.

◆ GetVersion()

static int vtkSocketCommunicator::GetVersion ( )
static

Uniquely identifies the version of this class.

If the versions match, then the socket communicators should be compatible.

◆ BufferCurrentMessage()

void vtkSocketCommunicator::BufferCurrentMessage ( )
inline

This flag is cleared before vtkCommand::WrongTagEvent is fired when ever a message with mismatched tag is received.

If the handler wants the message to be buffered for later use, it should set this flag to true. In which case the vtkSocketCommunicator will buffer the message and it will be automatically processed the next time one does a ReceiveTagged() with a matching tag.

Definition at line 250 of file vtkSocketCommunicator.h.

◆ HasBufferredMessages()

bool vtkSocketCommunicator::HasBufferredMessages ( )

Returns true if there are any messages in the receive buffer.

◆ SendTagged()

int vtkSocketCommunicator::SendTagged ( const void *  data,
int  wordSize,
int  numWords,
int  tag,
const char *  logName 
)
protected

◆ ReceiveTagged()

int vtkSocketCommunicator::ReceiveTagged ( void *  data,
int  wordSize,
int  numWords,
int  tag,
const char *  logName 
)
protected

◆ ReceivePartialTagged()

int vtkSocketCommunicator::ReceivePartialTagged ( void *  data,
int  wordSize,
int  numWords,
int  tag,
const char *  logName 
)
protected

◆ ReceivedTaggedFromBuffer()

int vtkSocketCommunicator::ReceivedTaggedFromBuffer ( void *  data,
int  wordSize,
int  numWords,
int  tag,
const char *  logName 
)
protected

◆ FixByteOrder()

void vtkSocketCommunicator::FixByteOrder ( void *  data,
int  wordSize,
int  numWords 
)
protected

Fix byte order for received data.

◆ LogTagged()

void vtkSocketCommunicator::LogTagged ( const char *  name,
const void *  data,
int  wordSize,
int  numWords,
int  tag,
const char *  logName 
)
protected

◆ CheckForErrorInternal()

int vtkSocketCommunicator::CheckForErrorInternal ( int  id)
protected

Member Data Documentation

◆ Socket

vtkClientSocket* vtkSocketCommunicator::Socket
protected

Definition at line 260 of file vtkSocketCommunicator.h.

◆ SwapBytesInReceivedData

int vtkSocketCommunicator::SwapBytesInReceivedData
protected

Definition at line 261 of file vtkSocketCommunicator.h.

◆ RemoteHas64BitIds

int vtkSocketCommunicator::RemoteHas64BitIds
protected

Definition at line 262 of file vtkSocketCommunicator.h.

◆ PerformHandshake

vtkTypeBool vtkSocketCommunicator::PerformHandshake
protected

Definition at line 263 of file vtkSocketCommunicator.h.

◆ IsServer

int vtkSocketCommunicator::IsServer
protected

Definition at line 264 of file vtkSocketCommunicator.h.

◆ ReportErrors

int vtkSocketCommunicator::ReportErrors
protected

Definition at line 266 of file vtkSocketCommunicator.h.

◆ LogFile

ofstream* vtkSocketCommunicator::LogFile
protected

Definition at line 268 of file vtkSocketCommunicator.h.

◆ LogStream

ostream* vtkSocketCommunicator::LogStream
protected

Definition at line 269 of file vtkSocketCommunicator.h.

◆ BufferMessage

bool vtkSocketCommunicator::BufferMessage
protected

Definition at line 295 of file vtkSocketCommunicator.h.


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