Reference documentation for deal.II version Git f982bbb689 2019-09-17 15:49:08 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Private Attributes | List of all members
Threads::PosixThreadBarrier Class Reference

#include <deal.II/base/thread_management.h>

Public Member Functions

 PosixThreadBarrier (const unsigned int count, const char *name=nullptr, void *arg=nullptr)
 
 ~PosixThreadBarrier ()
 
int wait ()
 

Private Attributes

pthread_barrier_t barrier
 

Detailed Description

Implementation of a thread barrier class, based on the POSIX thread functions. POSIX barriers are a relatively new feature and are not supported on all systems.

If the configuration detected the absence of these functions, then barriers will not be available, and creating objects of this class will result in an exception been thrown unless the count given for the parties waiting for the barrier is equal to one (as in this case waiting for the barrier is a no-operation, and we can dispense with the POSIX functions at all). The rest of the threading functionality will be available in its full extent, though, even if POSIX barriers are not available.

Deprecated:
This class is deprecated. It is easily possible to implement its functionality with the facilities provided by C++11.
Author
Wolfgang Bangerth, 2002

Definition at line 239 of file thread_management.h.

Constructor & Destructor Documentation

◆ PosixThreadBarrier()

Threads::PosixThreadBarrier::PosixThreadBarrier ( const unsigned int  count,
const char *  name = nullptr,
void *  arg = nullptr 
)

Constructor. Initialize the underlying POSIX barrier data structure.

Definition at line 155 of file thread_management.cc.

◆ ~PosixThreadBarrier()

Threads::PosixThreadBarrier::~PosixThreadBarrier ( )

Destructor. Release all resources.

Definition at line 185 of file thread_management.cc.

Member Function Documentation

◆ wait()

int Threads::PosixThreadBarrier::wait ( )

Wait for all threads to reach this point. The return value is zero for all participating threads except for one, for which the return value is some non-zero value. The operating system picks the special thread by some not further known method.

Definition at line 201 of file thread_management.cc.

Member Data Documentation

◆ barrier

pthread_barrier_t Threads::PosixThreadBarrier::barrier
private

Data object storing the POSIX data which we need to call the POSIX functions.

Definition at line 269 of file thread_management.h.


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