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 | List of all members
vtkThreadMessager Class Reference

A class for performing inter-thread messaging. More...

#include <vtkThreadMessager.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkThreadMessagerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void WaitForMessage ()
 
void SendWakeMessage ()
 
void EnableWaitForReceiver ()
 
void DisableWaitForReceiver ()
 
void WaitForReceiver ()
 

Static Public Member Functions

static vtkThreadMessagerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkThreadMessagerSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkThreadMessager ()
 
 ~vtkThreadMessager ()
 

Detailed Description

A class for performing inter-thread messaging.

vtkMultithreader is a class that provides support for messaging between threads multithreaded using pthreads or Windows messaging.

Definition at line 32 of file vtkThreadMessager.h.

Member Typedef Documentation

typedef vtkObject vtkThreadMessager::Superclass

Definition at line 37 of file vtkThreadMessager.h.

Constructor & Destructor Documentation

vtkThreadMessager::vtkThreadMessager ( )
protected
vtkThreadMessager::~vtkThreadMessager ( )
protected

Member Function Documentation

static vtkThreadMessager* vtkThreadMessager::New ( )
static
static int vtkThreadMessager::IsTypeOf ( const char *  type)
static
virtual int vtkThreadMessager::IsA ( const char *  type)
virtual
static vtkThreadMessager* vtkThreadMessager::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkThreadMessager::NewInstanceInternal ( ) const
protectedvirtual
vtkThreadMessager* vtkThreadMessager::NewInstance ( ) const
void vtkThreadMessager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkThreadMessager::WaitForMessage ( )

Wait (block, non-busy) until another thread sends a message.

void vtkThreadMessager::SendWakeMessage ( )

Send a message to all threads who are waiting via WaitForMessage().

void vtkThreadMessager::EnableWaitForReceiver ( )

pthreads only. If the wait is enabled, the thread who is to call WaitForMessage() will block until a receiver thread is ready to receive.

void vtkThreadMessager::DisableWaitForReceiver ( )

pthreads only. If the wait is enabled, the thread who is to call WaitForMessage() will block until a receiver thread is ready to receive.

void vtkThreadMessager::WaitForReceiver ( )

pthreads only. If wait is enable, this will block until one thread is ready to receive a message.


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