Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkSocketCommunicator Class Reference

Process communication using Sockets. More...

#include <vtkSocketCommunicator.h>

Inheritance diagram for vtkSocketCommunicator:

Inheritance graph
[legend]
Collaboration diagram for vtkSocketCommunicator:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize (int vtkNotUsed(argc), char *arcv[])
void SingleMethodExecute ()
void MultipleMethodExecute ()
virtual void SetNumberOfProcesses (int num)
virtual int WaitForConnection (int port, int timeout, int processId)
virtual void CloseConnection (int processId)
virtual int ConnectTo (char *hostName, int port, int processId)
int Send (int *data, int length, int remoteProcessId, int tag)
int Send (unsigned long *data, int length, int remoteProcessId, int tag)
int Send (char *data, int length, int remoteProcessId, int tag)
int Send (float *data, int length, int remoteProcessId, int tag)
int Send (vtkDataObject *data, int remoteId, int tag)
int Receive (int *data, int length, int remoteProcessId, int tag)
int Receive (unsigned long *data, int length, int remoteProcessId, int tag)
int Receive (char *data, int length, int remoteProcessId, int tag)
int Receive (float *data, int length, int remoteProcessId, int tag)
int Receive (vtkDataObject *data, int remoteId, int tag)

Static Public Methods

vtkSocketCommunicator * New ()
int IsTypeOf (const char *type)
vtkSocketCommunicator * SafeDownCast (vtkObject *o)

Protected Methods

 vtkSocketCommunicator ()
 ~vtkSocketCommunicator ()
 vtkSocketCommunicator (const vtkSocketCommunicator &)
void operator= (const vtkSocketCommunicator &)

Protected Attributes

int * Sockets
int * IsConnected
int Initialized

Detailed Description

Process communication using Sockets.

Date:
2000/12/10 20:08:26
Revision:
1.2

Definition at line 64 of file vtkSocketCommunicator.h.


Constructor & Destructor Documentation

vtkSocketCommunicator::vtkSocketCommunicator   [protected]
 

vtkSocketCommunicator::~vtkSocketCommunicator   [protected]
 

vtkSocketCommunicator::vtkSocketCommunicator const vtkSocketCommunicator &    [inline, protected]
 

Definition at line 124 of file vtkSocketCommunicator.h.


Member Function Documentation

vtkSocketCommunicator* vtkSocketCommunicator::New   [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkMultiProcessController.

virtual const char* vtkSocketCommunicator::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::IsTypeOf const char *    type [static]
 

Return 1 if this class type 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.

virtual int vtkSocketCommunicator::IsA const char *    type [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.

vtkSocketCommunicator* vtkSocketCommunicator::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkMultiProcessController.

void vtkSocketCommunicator::PrintSelf ostream &    os,
vtkIndent    indent
[virtual]
 

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.

virtual void vtkSocketCommunicator::Initialize int vtkNotUsed(argc)   ,
char *    arcv[]
[virtual]
 

This method is for setting the sockets. This is REQUIRED for Windows.

Reimplemented from vtkMultiProcessController.

void vtkSocketCommunicator::SingleMethodExecute   [inline, virtual]
 

Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes. You should not expect this to return.

Reimplemented from vtkMultiProcessController.

Definition at line 77 of file vtkSocketCommunicator.h.

void vtkSocketCommunicator::MultipleMethodExecute   [inline, virtual]
 

Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.

Reimplemented from vtkMultiProcessController.

Definition at line 82 of file vtkSocketCommunicator.h.

virtual void vtkSocketCommunicator::SetNumberOfProcesses int    num [virtual]
 

Set the number of processes you will be using.

Reimplemented from vtkMultiProcessController.

virtual int vtkSocketCommunicator::WaitForConnection int    port,
int    timeout,
int    processId
[virtual]
 

Wait for connection on a given port

virtual void vtkSocketCommunicator::CloseConnection int    processId [virtual]
 

Close a connection

virtual int vtkSocketCommunicator::ConnectTo char *    hostName,
int    port,
int    processId
[virtual]
 

Open a connection to a give machine

int vtkSocketCommunicator::Send int *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Send unsigned long *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Send char *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Send float *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Send vtkDataObject   data,
int    remoteId,
int    tag
[inline, virtual]
 

This method sends an object to another process. Tag eliminates ambiguity and is used to match sends to receives.

Reimplemented from vtkMultiProcessController.

Definition at line 104 of file vtkSocketCommunicator.h.

int vtkSocketCommunicator::Receive int *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data.

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Receive unsigned long *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Receive char *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Receive float *    data,
int    length,
int    remoteProcessId,
int    tag
[virtual]
 

Reimplemented from vtkMultiProcessController.

int vtkSocketCommunicator::Receive vtkDataObject   data,
int    remoteId,
int    tag
[inline, virtual]
 

This method receives a data object from a corresponding send. It blocks until the receive is finished.

Reimplemented from vtkMultiProcessController.

Definition at line 114 of file vtkSocketCommunicator.h.

void vtkSocketCommunicator::operator= const vtkSocketCommunicator &    [inline, protected]
 

Definition at line 125 of file vtkSocketCommunicator.h.


Member Data Documentation

int* vtkSocketCommunicator::Sockets [protected]
 

Definition at line 119 of file vtkSocketCommunicator.h.

int* vtkSocketCommunicator::IsConnected [protected]
 

Definition at line 120 of file vtkSocketCommunicator.h.

int vtkSocketCommunicator::Initialized [protected]
 

Definition at line 128 of file vtkSocketCommunicator.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 13:00:23 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001