|
VTK
9.0.1
|
Encapsulate a socket that accepts connections. More...
#include <vtkServerSocket.h>
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... | |
| 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 *) |
| 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) |
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 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 vtkServerSocket * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkServerSocket * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkSocket | |
| 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 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 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 |
| 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=nullptr) |
| 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 | |
| std::atomic< int32_t > | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Encapsulate a socket that accepts connections.
Definition at line 29 of file vtkServerSocket.h.
| typedef vtkSocket vtkServerSocket::Superclass |
Definition at line 33 of file vtkServerSocket.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.
| vtkServerSocket* vtkServerSocket::NewInstance | ( | ) | const |
|
overridevirtual |
| int vtkServerSocket::CreateServer | ( | int | port | ) |
Creates a server socket at a given port and binds to it.
Returns -1 on error. 0 on success.
| 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 nullptr on timeout.
| int vtkServerSocket::GetServerPort | ( | ) |
Returns the port on which the server is running.
1.8.17