Encapsulate a socket that accepts connections. More...

#include <vtkServerSocket.h>

Inheritance diagram for vtkServerSocket:

Collaboration diagram for vtkServerSocket:

Public Types
typedef vtkSocket	Superclass

Public Types inherited from vtkSocket
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkServerSocket *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	CreateServer (int port)
	Creates a server socket at a given port and binds to it. More...

vtkClientSocket *	WaitForConnection (unsigned long msec=0)
	Waits for a connection. More...

int	GetServerPort ()
	Returns the port on which the server is running. More...

Public Member Functions inherited from vtkSocket
vtkSocket *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetConnected ()
	Check is the socket is alive. More...

void	CloseSocket ()
	Close the socket. More...

int	Send (const void *data, int length)
	These methods send data over the socket. More...

int	Receive (void *data, int length, int readFully=1)
	Receive data from the socket. More...

virtual int	GetSocketDescriptor ()
	Provides access to the internal socket descriptor. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkServerSocket *	New ()

static int	IsTypeOf (const char *type)

static vtkServerSocket *	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)
	Selects set of sockets. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkServerSocket ()

	~vtkServerSocket () override

Protected Member Functions inherited from vtkSocket
	vtkSocket ()

	~vtkSocket () override

int	CreateSocket ()
	Creates an endpoint for communication and returns the descriptor. More...

void	CloseSocket (int socketdescriptor)
	Close the socket. More...

int	BindSocket (int socketdescriptor, int port)
	Binds socket to a particular port. More...

int	SelectSocket (int socketdescriptor, unsigned long msec)
	Selects a socket ie. More...

int	Accept (int socketdescriptor)
	Accept a connection on a socket. More...

int	Listen (int socketdescriptor)
	Listen for connections on a socket. More...

int	Connect (int socketdescriptor, const char *hostname, int port)
	Connect to a server socket. More...

int	GetPort (int socketdescriptor)
	Returns the port to which the socket is connected. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

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 &)

Additional Inherited Members
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

Detailed Description

Encapsulate a socket that accepts connections.

Definition at line 29 of file vtkServerSocket.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSocket vtkServerSocket::Superclass

Definition at line 33 of file vtkServerSocket.h.

Constructor & Destructor Documentation

◆ vtkServerSocket()

vtkServerSocket::vtkServerSocket ( )

protected

◆ ~vtkServerSocket()

vtkServerSocket::~vtkServerSocket ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkServerSocket* vtkServerSocket::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkServerSocket::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSocket.

◆ NewInstance()

vtkServerSocket* vtkServerSocket::NewInstance ( ) const

◆ PrintSelf()

void vtkServerSocket::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ CreateServer()

int vtkServerSocket::CreateServer ( int port )

Creates a server socket at a given port and binds to it.

Returns -1 on error. 0 on success.

◆ WaitForConnection()

vtkClientSocket* vtkServerSocket::WaitForConnection ( unsigned long msec = 0 )

Waits for a connection.

When a connection is received a new vtkClientSocket object is created and returned. Returns NULL on timeout.

◆ GetServerPort()

int vtkServerSocket::GetServerPort ( )

Returns the port on which the server is running.

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

dox/Common/System/vtkServerSocket.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkServerSocket()

◆ ~vtkServerSocket()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ CreateServer()

◆ WaitForConnection()

◆ GetServerPort()