BSD socket encapsulation. More...

#include <vtkSocket.h>

Inheritance diagram for vtkSocket:

Collaboration diagram for vtkSocket:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

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 int	IsTypeOf (const char *type)

static vtkSocket *	SafeDownCast (vtkObjectBase *o)

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

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)

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
int	SocketDescriptor

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSocketCollection

static int	SelectSockets (const int sockets_to_select, int size, unsigned long msec, int selected_index)

	vtkSocket ()

	~vtkSocket ()

Detailed Description

BSD socket encapsulation.

This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.

Definition at line 29 of file vtkSocket.h.

Member Typedef Documentation

typedef vtkObject vtkSocket::Superclass

Definition at line 32 of file vtkSocket.h.

Constructor & Destructor Documentation

vtkSocket::vtkSocket ( )

protected

Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index

vtkSocket::~vtkSocket ( )

protected

Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index

Member Function Documentation

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

static

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

Reimplemented in vtkServerSocket, and vtkClientSocket.

static vtkSocket* vtkSocket::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkSocket::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkServerSocket, and vtkClientSocket.

vtkSocket* vtkSocket::NewInstance ( ) const

void vtkSocket::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 vtkSocket::GetConnected ( )

inline

Check is the socket is alive.

Definition at line 37 of file vtkSocket.h.

void vtkSocket::CloseSocket ( )

Close the socket.

int vtkSocket::Send	(	const void *	data,
		int	length
	)

These methods send data over the socket. Returns 1 on success, 0 on error and raises vtkCommand::ErrorEvent.

int vtkSocket::Receive	(	void *	data,
		int	length,
		int	readFully = `1`
	)

Receive data from the socket. This call blocks until some data is read from the socket. When readFully is set, this call will block until all the requested data is read from the socket. 0 on error, else number of bytes read is returned. On error, vtkCommand::ErrorEvent is raised.

virtual int vtkSocket::GetSocketDescriptor ( )

virtual

Provides access to the internal socket descriptor. This is valid only when GetConnected() returns true.

static int vtkSocket::SelectSockets	(	const int *	sockets_to_select,
		int	size,
		unsigned long	msec,
		int *	selected_index
	)

static

Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index

int vtkSocket::CreateSocket ( )

protected

Creates an endpoint for communication and returns the descriptor. -1 indicates error.

void vtkSocket::CloseSocket ( int socketdescriptor )

protected

Close the socket.

int vtkSocket::BindSocket	(	int	socketdescriptor,
		int	port
	)

protected

Binds socket to a particular port. Returns 0 on success other -1 is returned.

int vtkSocket::SelectSocket	(	int	socketdescriptor,
		unsigned long	msec
	)

protected

Selects a socket ie. waits for it to change status. Returns 1 on success; 0 on timeout; -1 on error. msec=0 implies no timeout.

int vtkSocket::Accept ( int socketdescriptor )

protected

Accept a connection on a socket. Returns -1 on error. Otherwise the descriptor of the accepted socket.

int vtkSocket::Listen ( int socketdescriptor )

protected

Listen for connections on a socket. Returns 0 on success. -1 on error.

int vtkSocket::Connect	(	int	socketdescriptor,
		const char *	hostname,
		int	port
	)

protected

Connect to a server socket. Returns 0 on success, -1 on error.

int vtkSocket::GetPort ( int socketdescriptor )

protected

Returns the port to which the socket is connected. 0 on error.

Friends And Related Function Documentation

friend class vtkSocketCollection

friend

Definition at line 73 of file vtkSocket.h.

Member Data Documentation

int vtkSocket::SocketDescriptor

protected

Definition at line 70 of file vtkSocket.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/vtkSocket.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation