Condition Class Reference

#include <xmipp_threads.h>

Public Member Functions
	Condition ()
	~Condition ()
void	lock ()
void	unlock ()
void	wait ()
void	signal ()
void	broadcast ()

Detailed Description

Class wrapping around the pthreads condition. This class will provide a more object oriented implementation of a condition variable to achieve synchronization between threads.

Definition at line 88 of file xmipp_threads.h.

Constructor & Destructor Documentation

Condition()

Condition::Condition

(

)

Default constructor. This constructor just initialize the pthread_mutex_t structure with its defaults values, just like static initialization with PTHREAD_MUTEX_INITIALIZER

Definition at line 58 of file xmipp_threads.cpp.

{
    mutex = new Mutex();
    pthread_cond_init(&cond, NULL);
}

~Condition()

Condition::~Condition

(

)

Destructor.

Definition at line 64 of file xmipp_threads.cpp.

{
    delete mutex;
    pthread_cond_destroy(&cond);
}

Member Function Documentation

broadcast()

void Condition::broadcast

(

)

Send the signal to all waiting threads.

Definition at line 90 of file xmipp_threads.cpp.

{
    pthread_cond_broadcast(&cond);
}

lock()

void Condition::lock

(

)

Function to get the access to the mutex.

Definition at line 70 of file xmipp_threads.cpp.

{
    mutex->lock();
}

signal()

void Condition::signal

(

)

Function to notify the condition was met. Thread that can be waiting in the condition will be awaked.

Definition at line 85 of file xmipp_threads.cpp.

{
    pthread_cond_signal(&cond);
}

unlock()

void Condition::unlock

(

)

Function to release the mutex.

Definition at line 75 of file xmipp_threads.cpp.

{
    mutex->unlock();
}

wait()

void Condition::wait

(

)

Function to be call from a thread to wait on the condition. This function should be called after acquiring the Condition lock...after that, will block the threads until the condition be signaled.

Definition at line 80 of file xmipp_threads.cpp.

{
    pthread_cond_wait(&cond, &(mutex->mutex));
}

---

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

• xmippCore/core/xmipp_threads.h
• xmippCore/core/xmipp_threads.cpp