vtkClientSocket Class Reference

#include <vtkClientSocket.h>

Inheritance diagram for vtkClientSocket:

[legend]

Collaboration diagram for vtkClientSocket:

[legend]

List of all members.

---

Detailed Description

Encapsulates a client socket.

Definition at line 25 of file vtkClientSocket.h.

Public Types
typedef vtkSocket	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	ConnectToServer (const char *hostname, int port)
virtual bool	GetConnectingSide ()
Static Public Member Functions
static vtkClientSocket *	New ()
static int	IsTypeOf (const char *type)
static vtkClientSocket *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkClientSocket ()
	~vtkClientSocket ()
virtual void	SetConnectingSide (bool)
Protected Attributes
bool	ConnectingSide
Friends
class	vtkServerSocket

---

Member Typedef Documentation

typedef vtkSocket vtkClientSocket::Superclass

Reimplemented from vtkSocket.

Definition at line 29 of file vtkClientSocket.h.

---

Constructor & Destructor Documentation

vtkClientSocket::vtkClientSocket

(

)

[protected]

vtkClientSocket::~vtkClientSocket

(

)

[protected]

---

Member Function Documentation

static vtkClientSocket* vtkClientSocket::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkClientSocket::GetClassName

(

)

[virtual]

Reimplemented from vtkSocket.

static int vtkClientSocket::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 vtkSocket.

virtual int vtkClientSocket::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 vtkSocket.

static vtkClientSocket* vtkClientSocket::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSocket.

void vtkClientSocket::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 vtkSocket.

int vtkClientSocket::ConnectToServer	(	const char *	hostname,
		int	port
	)

Connects to host. Returns 0 on success, -1 on error.

virtual bool vtkClientSocket::GetConnectingSide

(

)

[virtual]

Returns if the socket is on the connecting side (the side that requests a ConnectToServer() or on the connected side (the side that was waiting for the client to connect). This is used to disambiguate the two ends of a socket connection.

virtual void vtkClientSocket::SetConnectingSide

(

bool

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class vtkServerSocket [friend]

Definition at line 50 of file vtkClientSocket.h.

---

Member Data Documentation

bool vtkClientSocket::ConnectingSide [protected]

Definition at line 48 of file vtkClientSocket.h.

---

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

• dox/Common/vtkClientSocket.h