99 lines
2.6 KiB
C
99 lines
2.6 KiB
C
|
/*=========================================================================
|
||
|
|
|
||
|
|
Program: Visualization Toolkit
|
||
|
|
Module: vtkThreadMessager.h
|
||
|
|
|
||
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
||
|
|
All rights reserved.
|
||
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
||
|
|
|
||
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
||
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
||
|
|
PURPOSE. See the above copyright notice for more information.
|
||
|
|
|
||
|
|
=========================================================================*/
|
||
|
|
/**
|
||
|
|
* @class vtkThreadMessager
|
||
|
|
* @brief A class for performing inter-thread messaging
|
||
|
|
*
|
||
|
|
* vtkThreadMessager is a class that provides support for messaging between
|
||
|
|
* threads multithreaded using pthreads or Windows messaging.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef vtkThreadMessager_h
|
||
|
|
#define vtkThreadMessager_h
|
||
|
|
|
||
|
|
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_1_0
|
||
|
|
|
||
|
|
#include "vtkCommonSystemModule.h" // For export macro
|
||
|
|
#include "vtkObject.h"
|
||
|
|
#include "vtkThreads.h" // for VTK_USE_PTHREADS and VTK_USE_WIN32_THREADS
|
||
|
|
|
||
|
|
#if defined(VTK_USE_PTHREADS)
|
||
|
|
#include <pthread.h> // Needed for pthread types
|
||
|
|
#endif
|
||
|
|
|
||
|
|
class VTK_DEPRECATED_IN_9_1_0(
|
||
|
|
"Use C++ STL threading classes") VTKCOMMONSYSTEM_EXPORT vtkThreadMessager : public vtkObject
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
static vtkThreadMessager* New();
|
||
|
|
|
||
|
|
vtkTypeMacro(vtkThreadMessager, vtkObject);
|
||
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Wait (block, non-busy) until another thread sends a
|
||
|
|
* message.
|
||
|
|
*/
|
||
|
|
void WaitForMessage();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Send a message to all threads who are waiting via
|
||
|
|
* WaitForMessage().
|
||
|
|
*/
|
||
|
|
void SendWakeMessage();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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 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 DisableWaitForReceiver();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* pthreads only.
|
||
|
|
* If wait is enable, this will block until one thread is ready
|
||
|
|
* to receive a message.
|
||
|
|
*/
|
||
|
|
void WaitForReceiver();
|
||
|
|
|
||
|
|
protected:
|
||
|
|
vtkThreadMessager();
|
||
|
|
~vtkThreadMessager() override;
|
||
|
|
|
||
|
|
#ifdef VTK_USE_PTHREADS
|
||
|
|
pthread_mutex_t Mutex;
|
||
|
|
pthread_cond_t PSignal;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef VTK_USE_WIN32_THREADS
|
||
|
|
vtkWindowsHANDLE WSignal;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
private:
|
||
|
|
vtkThreadMessager(const vtkThreadMessager&) = delete;
|
||
|
|
void operator=(const vtkThreadMessager&) = delete;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
// VTK-HeaderTest-Exclude: vtkThreadMessager.h
|