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 Member Functions
virtual int	IsA (const char *type)
vtkSocketController *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SingleMethodExecute ()
void	MultipleMethodExecute ()
void	CreateOutputWindow ()
virtual int	WaitForConnection (int port)
virtual void	CloseConnection ()
virtual int	ConnectTo (const char *hostName, int port)
int	GetSwapBytesInReceivedData ()
void	SetCommunicator (vtkSocketCommunicator *comm)
vtkMultiProcessController *	CreateCompliantController ()

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 (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSocketController ()
	~vtkSocketController ()
Static Protected Attributes
static int	Initialized

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.

@sa

vtkMultiProcessController vtkSocketCommunicator vtkInputPort vtkOutputPort

Tests:: vtkSocketController (Tests)

Definition at line 51 of file vtkSocketController.h.

Member Typedef Documentation

typedef vtkMultiProcessController vtkSocketController::Superclass

Reimplemented from vtkMultiProcessController.

Definition at line 55 of file vtkSocketController.h.

Member Enumeration Documentation

enum vtkSocketController::Consts

Enumerator:

ENDIAN_TAG
IDTYPESIZE_TAG
VERSION_TAG
HASH_TAG

Reimplemented from vtkMultiProcessController.

Definition at line 108 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.

static int vtkSocketController::IsTypeOf ( const char * name ) [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 * 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.

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

Reimplemented from vtkMultiProcessController.

virtual vtkObjectBase* vtkSocketController::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkMultiProcessController.

vtkSocketController* vtkSocketController::NewInstance ( ) const

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

virtual void vtkSocketController::Initialize	(	int *	argc,
		char ***	argv
	)		`[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 64 of file vtkSocketController.h.

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