VTK
Public Types | Public Member Functions | Static Public Member Functions | List of all members
vtkServerSocket Class Reference

Encapsulate a socket that accepts connections. More...

#include <vtkServerSocket.h>

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

Public Types

typedef vtkSocket Superclass
 
- Public Types inherited from vtkSocket
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int CreateServer (int port)
 
vtkClientSocketWaitForConnection (unsigned long msec=0)
 
- Public Member Functions inherited from vtkSocket
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetConnected ()
 
void CloseSocket ()
 
int Send (const void *data, int length)
 
int Receive (void *data, int length, int readFully=1)
 
virtual int GetSocketDescriptor ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkServerSocketNew ()
 
static int IsTypeOf (const char *type)
 
static vtkServerSocketSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSocket
static int IsTypeOf (const char *type)
 
static vtkSocketSafeDownCast (vtkObject *o)
 
static int SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
int GetServerPort ()
 
 vtkServerSocket ()
 
 ~vtkServerSocket ()
 

Additional Inherited Members

- Protected Member Functions inherited from vtkSocket
int CreateSocket ()
 
void CloseSocket (int socketdescriptor)
 
int BindSocket (int socketdescriptor, int port)
 
int SelectSocket (int socketdescriptor, unsigned long msec)
 
int Accept (int socketdescriptor)
 
int Listen (int socketdescriptor)
 
int Connect (int socketdescriptor, const char *hostname, int port)
 
int GetPort (int socketdescriptor)
 
 vtkSocket ()
 
 ~vtkSocket ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
- Protected Attributes inherited from vtkSocket
int SocketDescriptor
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Encapsulate a socket that accepts connections.

Definition at line 27 of file vtkServerSocket.h.

Member Typedef Documentation

Definition at line 31 of file vtkServerSocket.h.

Constructor & Destructor Documentation

vtkServerSocket::vtkServerSocket ( )
protected

Returns the port on which the server is running.

vtkServerSocket::~vtkServerSocket ( )
protected

Returns the port on which the server is running.

Member Function Documentation

static vtkServerSocket* vtkServerSocket::New ( )
static
virtual const char* vtkServerSocket::GetClassName ( )
virtual

Reimplemented from vtkSocket.

static int vtkServerSocket::IsTypeOf ( const char *  type)
static
virtual int vtkServerSocket::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.

static vtkServerSocket* vtkServerSocket::SafeDownCast ( vtkObject o)
static
void vtkServerSocket::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 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 NULL on timeout.

int vtkServerSocket::GetServerPort ( )

Returns the port on which the server is running.


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