vtkServerSocket Class Reference

#include <vtkServerSocket.h>

Inheritance diagram for vtkServerSocket:

Inheritance graph
[legend]
Collaboration diagram for vtkServerSocket:

Collaboration graph
[legend]

List of all members.


Detailed Description

Encapsulate a socket that accepts connections.

Definition at line 27 of file vtkServerSocket.h.


Public Types

typedef vtkSocket 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)
int GetServerPort ()

Static Public Member Functions

static vtkServerSocketNew ()
static int IsTypeOf (const char *type)
static vtkServerSocketSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkServerSocket ()
 ~vtkServerSocket ()

Member Typedef Documentation

Reimplemented from vtkSocket.

Definition at line 31 of file vtkServerSocket.h.


Constructor & Destructor Documentation

vtkServerSocket::vtkServerSocket (  )  [protected]

vtkServerSocket::~vtkServerSocket (  )  [protected]


Member Function Documentation

static vtkServerSocket* vtkServerSocket::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkServerSocket::GetClassName (  )  [virtual]

Reimplemented from vtkSocket.

static int vtkServerSocket::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkSocket.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkSocket.

static vtkServerSocket* vtkServerSocket::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkSocket.

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

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:

Generated on Wed Jun 3 19:33:32 2009 for VTK by  doxygen 1.5.6