VTK
9.0.2
|
Encapsulates a client socket. More...
#include <vtkClientSocket.h>
Public Types | |
typedef vtkSocket | Superclass |
![]() | |
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... | |
vtkClientSocket * | NewInstance () 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... | |
![]() | |
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... | |
![]() | |
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 *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
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) |
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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (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... | |
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 vtkClientSocket * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkClientSocket * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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. More... | |
![]() | |
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 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 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 |
vtkClientSocket () | |
~vtkClientSocket () override | |
virtual void | SetConnectingSide (bool) |
![]() | |
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... | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
bool | ConnectingSide |
![]() | |
int | SocketDescriptor |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Friends | |
class | vtkServerSocket |
Encapsulates a client socket.
Definition at line 27 of file vtkClientSocket.h.
typedef vtkSocket vtkClientSocket::Superclass |
Definition at line 31 of file vtkClientSocket.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkSocket.
vtkClientSocket* vtkClientSocket::NewInstance | ( | ) | const |
|
overridevirtual |
int vtkClientSocket::ConnectToServer | ( | const char * | hostname, |
int | port | ||
) |
Connects to host.
Returns 0 on success, -1 on error.
|
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.
|
protectedvirtual |
|
friend |
Definition at line 55 of file vtkClientSocket.h.
|
protected |
Definition at line 54 of file vtkClientSocket.h.