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

Encapsulates a client socket. More...

#include <vtkClientSocket.h>

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

Public Types

typedef vtkSocket Superclass
 
- Public Types inherited from vtkSocket
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. More...
 
vtkClientSocketNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int ConnectToServer (const char *hostname, int port)
 Connects to host. More...
 
virtual bool GetConnectingSide ()
 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). More...
 
- Public Member Functions inherited from vtkSocket
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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkClientSocketNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkClientSocketSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSocket
static vtkTypeBool 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkClientSocket ()
 
 ~vtkClientSocket () override
 
virtual void SetConnectingSide (bool)
 
- 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=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 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkServerSocket
 

Additional Inherited Members

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

Detailed Description

Encapsulates a client socket.

Definition at line 27 of file vtkClientSocket.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkClientSocket.h.

Constructor & Destructor Documentation

◆ vtkClientSocket()

vtkClientSocket::vtkClientSocket ( )
protected

◆ ~vtkClientSocket()

vtkClientSocket::~vtkClientSocket ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkClientSocket* vtkClientSocket::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkClientSocket::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSocket.

◆ NewInstance()

vtkClientSocket* vtkClientSocket::NewInstance ( ) const

◆ PrintSelf()

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

◆ ConnectToServer()

int vtkClientSocket::ConnectToServer ( const char *  hostname,
int  port 
)

Connects to host.

Returns 0 on success, -1 on error.

◆ GetConnectingSide()

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.

◆ SetConnectingSide()

virtual void vtkClientSocket::SetConnectingSide ( bool  )
protectedvirtual

Friends And Related Function Documentation

◆ vtkServerSocket

friend class vtkServerSocket
friend

Definition at line 55 of file vtkClientSocket.h.

Member Data Documentation

◆ ConnectingSide

bool vtkClientSocket::ConnectingSide
protected

Definition at line 54 of file vtkClientSocket.h.


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