vtkSocketController Class Reference

#include <vtkSocketController.h>

Inheritance diagram for vtkSocketController:

[legend]Collaboration diagram for vtkSocketController:

[legend]List of all members.

---

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.

See also:

vtkMultiProcessController vtkSocketCommunicator vtkInputPort vtkOutputPort

Tests:

vtkSocketController (Tests)

Definition at line 37 of file vtkSocketController.h.

Public Types
typedef vtkMultiProcessController	Superclass
enum	Consts { ENDIAN_TAG = 1010580540 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	SingleMethodExecute ()
void	MultipleMethodExecute ()
void	CreateOutputWindow ()
void	Barrier ()
virtual void	SetNumberOfProcesses (int num)
virtual int	WaitForConnection (int port)
virtual void	CloseConnection ()
virtual int	ConnectTo (char *hostName, int port)
int	GetSwapBytesInReceivedData ()
void	SetCommunicator (vtkSocketCommunicator *comm)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize (int *argc, char ***argv, int)
virtual void	Initialize (int *argc, char ***argv)
virtual void	Initialize ()
void	Finalize ()
void	Finalize (int)
Static Public Member Functions
static vtkSocketController *	New ()
static int	IsTypeOf (const char *type)
static vtkSocketController *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSocketController ()
	~vtkSocketController ()
Static Protected Attributes
static int	Initialized

---

Member Typedef Documentation

typedef vtkMultiProcessController vtkSocketController::Superclass

Reimplemented from vtkMultiProcessController. Definition at line 41 of file vtkSocketController.h.

---

Member Enumeration Documentation

enum vtkSocketController::Consts

Enumerator: ENDIAN_TAG  Reimplemented from vtkMultiProcessController. Definition at line 91 of file vtkSocketController.h.

---

Constructor & Destructor Documentation

vtkSocketController::vtkSocketController (   )  [protected]

vtkSocketController::~vtkSocketController (   )  [protected]

---

Member Function Documentation

static vtkSocketController* vtkSocketController::New (   )  [static]

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

virtual const char* vtkSocketController::GetClassName (   )  [virtual]

Reimplemented from vtkMultiProcessController.

static int vtkSocketController::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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkMultiProcessController.

virtual int vtkSocketController::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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkMultiProcessController.

static vtkSocketController* vtkSocketController::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkMultiProcessController.

void vtkSocketController::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 vtkSocketController::Initialize (  int *  argc, char ***  argv, int  )  [inline, virtual]

This method is for initialiazing sockets. One of these is REQUIRED for Windows. Definition at line 47 of file vtkSocketController.h. References vtkMultiProcessController::Initialize().

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

virtual void vtkSocketController::Initialize (   )  [inline, virtual]

Definition at line 50 of file vtkSocketController.h. References vtkMultiProcessController::Initialize().

void vtkSocketController::Finalize (   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 56 of file vtkSocketController.h.

void vtkSocketController::Finalize (  int   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 57 of file vtkSocketController.h.

void vtkSocketController::SingleMethodExecute (   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 61 of file vtkSocketController.h.

void vtkSocketController::MultipleMethodExecute (   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 64 of file vtkSocketController.h.

void vtkSocketController::CreateOutputWindow (   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 67 of file vtkSocketController.h.

void vtkSocketController::Barrier (   )  [inline, virtual]

Does not apply to sockets. Does nothing. Implements vtkMultiProcessController. Definition at line 70 of file vtkSocketController.h.

virtual void vtkSocketController::SetNumberOfProcesses (  int  num  )  [virtual]

Set the number of processes you will be using. Reimplemented from vtkMultiProcessController.

virtual int vtkSocketController::WaitForConnection (  int  port  )  [virtual]

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

virtual void vtkSocketController::CloseConnection (   )  [virtual]

Close a connection, forwarded to the communicator

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

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

int vtkSocketController::GetSwapBytesInReceivedData (   )

void vtkSocketController::SetCommunicator (  vtkSocketCommunicator *  comm  )

Set the communicator used in normal and rmi communications.

---

Member Data Documentation

int vtkSocketController::Initialized [static, protected]

Definition at line 103 of file vtkSocketController.h.

---

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

• dox/Parallel/vtkSocketController.h

---