---

vtkSocketController Class Reference

Process communication using Sockets. More...

#include <vtkSocketController.h>

Inheritance diagram for vtkSocketController:

[legend]Collaboration diagram for vtkSocketController:

[legend]List of all members.

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

---

Detailed Description

Process communication using Sockets.

Date:

2001/10/11 13:38:01

Revision:

1.11

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 75 of file vtkSocketController.h.

---

Member Enumeration Documentation

enum vtkSocketController::Consts

Enumeration values: ENDIAN_TAG  Reimplemented from vtkMultiProcessController. Definition at line 146 of file vtkSocketController.h.

---

Constructor & Destructor Documentation

vtkSocketController::vtkSocketController (    )  [protected]

vtkSocketController::~vtkSocketController (    )  [protected]

---

Member Function Documentation

vtkSocketController* vtkSocketController::New (    )  [static]

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

virtual const char* vtkSocketController::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 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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkMultiProcessController.

vtkSocketController* vtkSocketController::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 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 *   , char ***    )  [virtual]

This method is for initialiazing sockets. One of these is REQUIRED for Windows.

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

This method is for initialiazing sockets. One of these is REQUIRED for Windows. Definition at line 86 of file vtkSocketController.h.

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

Does not apply to sockets. Does nothing. Reimplemented from vtkMultiProcessController. Definition at line 91 of file vtkSocketController.h.

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

Does not apply to sockets. Does nothing. Reimplemented from vtkMultiProcessController. Definition at line 94 of file vtkSocketController.h.

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

Does not apply to sockets. Does nothing. Reimplemented from vtkMultiProcessController. Definition at line 97 of file vtkSocketController.h.

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

Does not apply to sockets. Does nothing. Reimplemented from vtkMultiProcessController. Definition at line 100 of file vtkSocketController.h.

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

Does not apply to sockets. Does nothing. Reimplemented from vtkMultiProcessController. Definition at line 103 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 )  [inline, virtual]

Wait for connection on a given port, forwarded to the communicator Definition at line 110 of file vtkSocketController.h.

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

Close a connection, forwarded to the communicator Definition at line 119 of file vtkSocketController.h.

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

Open a connection to a give machine, forwarded to the communicator Definition at line 128 of file vtkSocketController.h.

int vtkSocketController::GetSwapBytesInReceivedData (    )  [inline]

Definition at line 135 of file vtkSocketController.h.

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 158 of file vtkSocketController.h.

---

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

• Parallel/vtkSocketController.h

---