VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSocketCollection Class Reference

a collection for sockets. More...

#include <vtkSocketCollection.h>

Inherits vtkCollection.

Collaboration diagram for vtkSocketCollection:
[legend]

Public Types

typedef vtkCollection Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSocketCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void AddItem (vtkSocket *soc)
 
int SelectSockets (unsigned long msec=0)
 
vtkSocketGetLastSelectedSocket ()
 

Static Public Member Functions

static vtkSocketCollectionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSocketCollectionSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 

Protected Attributes

vtkSocketSelectedSocket
 
void ReplaceItem (int i, vtkObject *)
 
void RemoveItem (int i)
 
void RemoveItem (vtkObject *)
 
void RemoveAllItems ()
 
 vtkSocketCollection ()
 
 ~vtkSocketCollection ()
 

Detailed Description

a collection for sockets.

Apart from being vtkCollection subclass for sockets, this class provides means to wait for activity on all the sockets in the collection simultaneously.

Definition at line 30 of file vtkSocketCollection.h.

Member Typedef Documentation

typedef vtkCollection vtkSocketCollection::Superclass

Definition at line 34 of file vtkSocketCollection.h.

Constructor & Destructor Documentation

vtkSocketCollection::vtkSocketCollection ( )
protected

Overridden to unset SelectedSocket.

vtkSocketCollection::~vtkSocketCollection ( )
protected

Overridden to unset SelectedSocket.

Member Function Documentation

static vtkSocketCollection* vtkSocketCollection::New ( )
static
static int vtkSocketCollection::IsTypeOf ( const char *  type)
static
virtual int vtkSocketCollection::IsA ( const char *  type)
virtual
static vtkSocketCollection* vtkSocketCollection::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSocketCollection::NewInstanceInternal ( ) const
protectedvirtual
vtkSocketCollection* vtkSocketCollection::NewInstance ( ) const
void vtkSocketCollection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkSocketCollection::AddItem ( vtkSocket soc)
int vtkSocketCollection::SelectSockets ( unsigned long  msec = 0)

Select all Connected sockets in the collection. If msec is specified, it timesout after msec milliseconds on inactivity. Returns 0 on timeout, -1 on error; 1 is a socket was selected. The selected socket can be retrieved by GetLastSelectedSocket().

vtkSocket* vtkSocketCollection::GetLastSelectedSocket ( )
inline

Returns the socket selected during the last SelectSockets(), if any. NULL otherwise.

Definition at line 49 of file vtkSocketCollection.h.

void vtkSocketCollection::ReplaceItem ( int  i,
vtkObject *   
)

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveItem ( int  i)

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveItem ( vtkObject *  )

Overridden to unset SelectedSocket.

void vtkSocketCollection::RemoveAllItems ( )

Overridden to unset SelectedSocket.

Member Data Documentation

vtkSocket* vtkSocketCollection::SelectedSocket
protected

Definition at line 64 of file vtkSocketCollection.h.


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