vtkSocket Class Reference

BSD socket encapsulation. More...

#include <vtkSocket.h>

Inheritance diagram for vtkSocket:

Collaboration diagram for vtkSocket:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSocket *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetConnected ()
	Check is the socket is alive.
void	CloseSocket ()
	Close the socket.
int	Send (const void *data, int length)
	These methods send data over the socket.
int	Receive (void *data, int length, int readFully=1)
	Receive data from the socket.
virtual int	GetSocketDescriptor ()
	Provides access to the internal socket descriptor.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	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.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSocket ()
	~vtkSocket () override
int	CreateSocket ()
	Creates an endpoint for communication and returns the descriptor.
void	CloseSocket (int socketdescriptor)
	Close the socket.
int	SelectSocket (int socketdescriptor, unsigned long msec)
	Selects a socket ie.
int	Accept (int socketdescriptor)
	Accept a connection on a socket.
int	Listen (int socketdescriptor)
	Listen for connections on a socket.
int	Connect (int socketdescriptor, const char *hostname, int port)
	Connect to a server socket.
int	GetPort (int socketdescriptor)
	Returns the port to which the socket is connected.
int	BindSocket (int socketdescriptor, int port, const std::string &bindAddr)
	Binds socket to a particular port and IPv4 address if specified.
int	BindSocket (int socketdescriptor, int port)
	Binds socket to a particular port and IPv4 address if specified.
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	SocketDescriptor
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkSocketCollection

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

BSD socket encapsulation.

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

Definition at line 19 of file vtkSocket.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkSocket::Superclass

Definition at line 22 of file vtkSocket.h.

Constructor & Destructor Documentation

vtkSocket()

vtkSocket::vtkSocket ( )

protected

~vtkSocket()

vtkSocket::~vtkSocket ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkClientSocket, and vtkServerSocket.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSocket::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkClientSocket, and vtkServerSocket.

NewInstance()

vtkSocket * vtkSocket::NewInstance

(

)

const

PrintSelf()

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

GetConnected()

int vtkSocket::GetConnected ( )

inline

Check is the socket is alive.

Definition at line 29 of file vtkSocket.h.

CloseSocket() [1/2]

void vtkSocket::CloseSocket

(

)

Close the socket.

Send()

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.

Receive()

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.

GetSocketDescriptor()

virtual int vtkSocket::GetSocketDescriptor ( )

virtual

Provides access to the internal socket descriptor.

This is valid only when GetConnected() returns true.

SelectSockets()

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 through selected_index

CreateSocket()

int vtkSocket::CreateSocket ( )

protected

Creates an endpoint for communication and returns the descriptor.

-1 indicates error.

CloseSocket() [2/2]

void vtkSocket::CloseSocket ( int  socketdescriptor )

protected

Close the socket.

BindSocket() [1/2]

int vtkSocket::BindSocket ( int  socketdescriptor, int  port, const std::string &  bindAddr  )

protected

Binds socket to a particular port and IPv4 address if specified.

bindAddr defaults to INADDR_ANY (0.0.0.0) if not specified. Returns 0 on success other -1 is returned.

BindSocket() [2/2]

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

protected

Binds socket to a particular port and IPv4 address if specified.

bindAddr defaults to INADDR_ANY (0.0.0.0) if not specified. Returns 0 on success other -1 is returned.

SelectSocket()

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.

Accept()

int vtkSocket::Accept ( int  socketdescriptor )

protected

Accept a connection on a socket.

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

Listen()

int vtkSocket::Listen ( int  socketdescriptor )

protected

Listen for connections on a socket.

Returns 0 on success. -1 on error.

Connect()

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

protected

Connect to a server socket.

Returns 0 on success, -1 on error.

GetPort()

int vtkSocket::GetPort ( int  socketdescriptor )

protected

Returns the port to which the socket is connected.

0 on error.

Friends And Related Symbol Documentation

vtkSocketCollection

friend class vtkSocketCollection

friend

Definition at line 73 of file vtkSocket.h.

Member Data Documentation

SocketDescriptor

int vtkSocket::SocketDescriptor

protected

Definition at line 71 of file vtkSocket.h.

---

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

• Common/System/vtkSocket.h