VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSocket Class Reference

BSD socket encapsulation. More...

#include <vtkSocket.h>

Inheritance diagram for vtkSocket:
[legend]
Collaboration diagram for vtkSocket:
[legend]

Public Types

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...
 
vtkSocketNewInstance () 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSocketSafeDownCast (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 vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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
 

Detailed Description

BSD socket encapsulation.

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

Definition at line 30 of file vtkSocket.h.

Member Typedef Documentation

Definition at line 33 of file vtkSocket.h.

Constructor & Destructor Documentation

vtkSocket::vtkSocket ( )
protected
vtkSocket::~vtkSocket ( )
overrideprotected

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

Reimplemented in vtkServerSocket, and vtkClientSocket.

static vtkSocket* vtkSocket::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkSocket::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkServerSocket, and vtkClientSocket.

vtkSocket* vtkSocket::NewInstance ( ) const
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.

int vtkSocket::GetConnected ( )
inline

Check is the socket is alive.

Definition at line 40 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 through 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 84 of file vtkSocket.h.

Member Data Documentation

int vtkSocket::SocketDescriptor
protected

Definition at line 82 of file vtkSocket.h.


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