TeMutex Class Reference
[Multi-programming tools.]

#include <TeMutex.h>

---

Detailed Description

A class to deal with critical region locking.

Author:

Emiliano F. Castejon <castejon@dpi.inpe.br>

Definition at line 49 of file TeMutex.h.

Public Member Functions
void	lock ()
	TeMutex ()
bool	tryLock ()
void	unLock ()
	~TeMutex ()
Private Member Functions
const TeMutex &	operator= (const TeMutex &)
	operator= overload.
	TeMutex (const TeMutex &)
	Alternative constructor.

---

Constructor & Destructor Documentation

TeMutex::TeMutex

(

)

Default constructor.

Definition at line 13 of file TeMutex.cpp.

References NULL, pthread_mutex_init, pthread_mutexattr_init, TEAGN_TRUE_OR_THROW, and TRUE.

{
  #if TePLATFORM == TePLATFORMCODE_MSWINDOWS
  
    m_sa_.nLength = sizeof( m_sa_ );
    m_sa_.lpSecurityDescriptor = NULL;
    m_sa_.bInheritHandle = TRUE;

    m_access_ = ::CreateMutex( &m_sa_, false, 0 );

    TEAGN_TRUE_OR_THROW( ( m_access_ != 0 ),
      "Unable to create mutex object instance" )
  
  #elif TePLATFORM == TePLATFORMCODE_LINUX || TePLATFORM == TePLATFORMCODE_AIX || TePLATFORM == TePLATFORMCODE_APPLE
  
    pthread_mutexattr_t access_attr;
    TEAGN_TRUE_OR_THROW( ( pthread_mutexattr_init( &access_attr ) == 0 ),
      "Unable to init mutex attributes" );

    pthread_mutexattr_settype( &access_attr, PTHREAD_MUTEX_DEFAULT );
    TEAGN_TRUE_OR_THROW( 
      ( pthread_mutex_init( &m_access_, &access_attr ) == 0 ),
      "Unable to init mutex" )
  
  #else
    #error "Unsuported plataform"
  #endif   
}

TeMutex::~TeMutex

(

)

Default destructor.

Definition at line 43 of file TeMutex.cpp.

References pthread_mutex_destroy, and unLock().

{
  unLock();
  
  #if TePLATFORM == TePLATFORMCODE_MSWINDOWS
  
    ::CloseHandle( m_access_ );
  
  #elif TePLATFORM == TePLATFORMCODE_LINUX || TePLATFORM == TePLATFORMCODE_AIX || TePLATFORM == TePLATFORMCODE_APPLE
  
    pthread_mutex_destroy( &m_access_ );
  
  #else
    #error "Unsuported plataform"
  #endif   
}

TeMutex::TeMutex

(

const TeMutex &

)

[inline, private]

Definition at line 172 of file TeMutex.h.

{};

---

Member Function Documentation

void TeMutex::lock

(

)

[inline]

Lock the current object instance.

Note:

If section is already busy then the current thread will be blocked until it's ready again.

Definition at line 68 of file TeMutex.h.

References pthread_mutex_lock, and TEAGN_DEBUG_CONDITION.

Referenced by TePDIParaSegStrategy::acquireNewSegID(), TePDIMMIOMatching::bicubicResampleMatrix(), TePDIMMIOMatching::calcCCorrelationMtx(), TeMultiContainer< TeMultiContainerKeyT >::clear(), PluginsParametersContainer< PluginsParametersContainerKeyT >::clear(), TeThreadJobsManager::clearAwaitingJobs(), TeCommunicator< DataType >::connect(), TeCommunicator< DataType >::ConnectMe(), TeCommunicator< DataType >::disconnect(), TeCommunicator< DataType >::DisconnectMe(), TeGeometricTransformation::eORThreadEntry(), TeThreadJobsManager::executeJob(), TePDIOFMatching::gaussianSmoothing(), TePDIMMIOMatching::generateCorrelationFeatures(), TePDIOFMatching::generateCorrWindows(), TePDIOFMatching::generateLSSurface(), TeThreadJobsManager::getAwaitingJobsNumber(), TeConnectionPool::getConnection(), TeThreadJobsManager::getJobStatus(), TeThreadJobsManager::getRunningJobsNumber(), TePDIParallelSegmenter::groupDataThreadEntry(), TeMultiContainer< TeMultiContainerKeyT >::isStored(), jobFunction(), TePDIMMIOMatching::loadImage(), TePDICorrelationMatching::loadImage(), main(), TeMultiContainer< TeMultiContainerKeyT >::multiRetrive(), TeSharedPtr< T >::operator=(), TeMultiContainer< TeMultiContainerKeyT >::operator=(), PluginsParametersContainer< PluginsParametersContainerKeyT >::operator=(), TeCommunicator< DataType >::Receive(), TeConnectionPool::releaseConnection(), TeMultiContainer< TeMultiContainerKeyT >::remove(), TeSharedPtr< T >::reset(), TeMultiContainer< TeMultiContainerKeyT >::retrive(), PluginsParametersContainer< PluginsParametersContainerKeyT >::retrive(), TePDISAMClassifier::SegThread::run(), TePDICorrelationMatching::CorrThread::run(), TePDIParallelSegmenter::segmenterThreadEntry(), TeCommunicator< DataType >::send(), TeCommunicator< DataType >::setHostObj(), TeMultiContainer< TeMultiContainerKeyT >::store(), PluginsParametersContainer< PluginsParametersContainerKeyT >::store(), TeThreadJobsManager::threadFunction(), TePDIPIManager::Toggle(), TePDIPIManager::Update(), and TeThreadJobsManager::~TeThreadJobsManager().

      {
        #if TePLATFORM == TePLATFORMCODE_MSWINDOWS
        
          DWORD return_value = 0;
          return_value = ::WaitForSingleObject( m_access_, INFINITE );
          TEAGN_DEBUG_CONDITION( ( ( return_value == WAIT_ABANDONED ) ||
            ( return_value == WAIT_OBJECT_0 ) ),
            "Unable to get mutex lock" );
        
                                #elif TePLATFORM == TePLATFORMCODE_LINUX || TePLATFORM == TePLATFORMCODE_AIX || TePLATFORM == TePLATFORMCODE_APPLE
        
          pthread_mutex_lock( &m_access_ );
        
        #else
          #error "Unsuported plataform"
        #endif  
      };      

const TeMutex& TeMutex::operator=

(

const TeMutex &

)

[inline, private]

Returns:

A const reference to the current instance.

Definition at line 179 of file TeMutex.h.

{ return *this; };

bool TeMutex::tryLock

(

)

[inline]

Try to lock the current object instance.

Returns:

true if OK, false if unable to lock.

Note:

If section is busy, this method will return false without blocking the current thread.

Definition at line 93 of file TeMutex.h.

References EBUSY, and pthread_mutex_trylock.

Referenced by main().

      {
        #if TePLATFORM == TePLATFORMCODE_MSWINDOWS
        
          DWORD return_value = ::WaitForSingleObject( m_access_, 
            10 );

          if( ( return_value == WAIT_OBJECT_0 ) ||
            ( return_value == WAIT_ABANDONED ) ) {

            return true;
          } else {
            return false;
          }
        
                                #elif TePLATFORM == TePLATFORMCODE_LINUX || TePLATFORM == TePLATFORMCODE_AIX || TePLATFORM == TePLATFORMCODE_APPLE

        
          if( pthread_mutex_trylock( &m_access_ ) == EBUSY ) {
            return false;
          } else {
            return true;
          }
        
        #else
          #error "Unsuported plataform"
        #endif  
      };      

void TeMutex::unLock

(

)

[inline]

Unlock the current object instance.

Definition at line 125 of file TeMutex.h.

References pthread_mutex_unlock.

Referenced by TePDIParaSegStrategy::acquireNewSegID(), TePDIMMIOMatching::bicubicResampleMatrix(), TePDIMMIOMatching::calcCCorrelationMtx(), TeMultiContainer< TeMultiContainerKeyT >::clear(), PluginsParametersContainer< PluginsParametersContainerKeyT >::clear(), TeThreadJobsManager::clearAwaitingJobs(), TeCommunicator< DataType >::connect(), TeCommunicator< DataType >::ConnectMe(), TeCommunicator< DataType >::disconnect(), TeCommunicator< DataType >::DisconnectMe(), TeGeometricTransformation::eORThreadEntry(), TeThreadJobsManager::executeJob(), TePDIOFMatching::gaussianSmoothing(), TePDIMMIOMatching::generateCorrelationFeatures(), TePDIOFMatching::generateCorrWindows(), TePDIOFMatching::generateLSSurface(), TeThreadJobsManager::getAwaitingJobsNumber(), TeConnectionPool::getConnection(), TeThreadJobsManager::getJobStatus(), TeThreadJobsManager::getRunningJobsNumber(), TePDIParallelSegmenter::groupDataThreadEntry(), TeMultiContainer< TeMultiContainerKeyT >::isStored(), jobFunction(), TePDIMMIOMatching::loadImage(), TePDICorrelationMatching::loadImage(), main(), TeMultiContainer< TeMultiContainerKeyT >::multiRetrive(), TeSharedPtr< T >::operator=(), TeMultiContainer< TeMultiContainerKeyT >::operator=(), PluginsParametersContainer< PluginsParametersContainerKeyT >::operator=(), TeCommunicator< DataType >::Receive(), TeConnectionPool::releaseConnection(), TeMultiContainer< TeMultiContainerKeyT >::remove(), TeSharedPtr< T >::reset(), TeMultiContainer< TeMultiContainerKeyT >::retrive(), PluginsParametersContainer< PluginsParametersContainerKeyT >::retrive(), TePDISAMClassifier::SegThread::run(), TePDICorrelationMatching::CorrThread::run(), TePDIParallelSegmenter::segmenterThreadEntry(), TeCommunicator< DataType >::send(), TeCommunicator< DataType >::setHostObj(), TeMultiContainer< TeMultiContainerKeyT >::store(), PluginsParametersContainer< PluginsParametersContainerKeyT >::store(), TeThreadJobsManager::threadFunction(), TePDIPIManager::Toggle(), TePDIPIManager::Update(), ~TeMutex(), and TeThreadJobsManager::~TeThreadJobsManager().

      {
        #if TePLATFORM == TePLATFORMCODE_MSWINDOWS
        
          ::ReleaseMutex( m_access_ );
        
                                #elif TePLATFORM == TePLATFORMCODE_LINUX || TePLATFORM == TePLATFORMCODE_AIX || TePLATFORM == TePLATFORMCODE_APPLE

        
          pthread_mutex_unlock( &m_access_ );
        
        #else
          #error "Unsuported plataform"
        #endif 
      };      

---

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

• TeMutex.h
• TeMutex.cpp

---