vtkClientSocket Class Reference

Encapsulates a client socket. More...

#include <vtkClientSocket.h>

Inheritance diagram for vtkClientSocket:

Collaboration diagram for vtkClientSocket:

Public Types
typedef vtkSocket	Superclass
Public Types inherited from vtkSocket
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkClientSocket *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	ConnectToServer (const char *hostname, int port)
virtual bool	GetConnectingSide ()
Public Member Functions inherited from vtkSocket
vtkSocket *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetConnected ()
void	CloseSocket ()
int	Send (const void *data, int length)
int	Receive (void *data, int length, int readFully=1)
virtual int	GetSocketDescriptor ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkClientSocket *	New ()
static int	IsTypeOf (const char *type)
static vtkClientSocket *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkSocket
static int	IsTypeOf (const char *type)
static vtkSocket *	SafeDownCast (vtkObjectBase *o)
static int	SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkClientSocket ()
	~vtkClientSocket ()
virtual void	SetConnectingSide (bool)
Protected Member Functions inherited from vtkSocket
int	CreateSocket ()
void	CloseSocket (int socketdescriptor)
int	BindSocket (int socketdescriptor, int port)
int	SelectSocket (int socketdescriptor, unsigned long msec)
int	Accept (int socketdescriptor)
int	Listen (int socketdescriptor)
int	Connect (int socketdescriptor, const char *hostname, int port)
int	GetPort (int socketdescriptor)
	vtkSocket ()
	~vtkSocket ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
bool	ConnectingSide
Protected Attributes inherited from vtkSocket
int	SocketDescriptor
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkServerSocket

Detailed Description

Encapsulates a client socket.

Definition at line 26 of file vtkClientSocket.h.

Member Typedef Documentation

typedef vtkSocket vtkClientSocket::Superclass

Definition at line 30 of file vtkClientSocket.h.

Constructor & Destructor Documentation

vtkClientSocket::vtkClientSocket ( )

protected

vtkClientSocket::~vtkClientSocket ( )

protected

Member Function Documentation

static vtkClientSocket* vtkClientSocket::New ( )

static

static int vtkClientSocket::IsTypeOf ( const char *  type )

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkClientSocket::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSocket.

vtkClientSocket* vtkClientSocket::NewInstance

(

)

const

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 vtkObject.

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  )

protectedvirtual

Friends And Related Function Documentation

friend class vtkServerSocket

friend

Definition at line 51 of file vtkClientSocket.h.

Member Data Documentation

bool vtkClientSocket::ConnectingSide

protected

Definition at line 49 of file vtkClientSocket.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/System/vtkClientSocket.h