CondVarPosix.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2005-01-17 22:34:01 -0600 (Mon, 17 Jan 2005) $
 * Version:       $Revision: 16635 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_COND_VAR_POSIX_H_
#define _VPR_COND_VAR_POSIX_H_

#include <vpr/vprConfig.h>
#include <stdlib.h>
#include <pthread.h>
#include <vpr/md/POSIX/Sync/MutexPosix.h>
#include <vpr/Util/Interval.h>


namespace vpr
{

class CondVarPosix
{
public:
   CondVarPosix(MutexPosix* mutex = NULL)
   {
      // Initialize the condition variable.
      pthread_cond_init(&mCondVar, NULL);

      // If the caller did not specify a mutex variable to use with
      // the condition variable, use mDefaultMutex.
      if ( mutex == NULL )
      {
         mutex = &mDefaultMutex;
      }

      mCondMutex = mutex;
   }

   ~CondVarPosix()
   {
      pthread_cond_destroy(&mCondVar);
   }

   vpr::ReturnStatus wait(vpr::Interval timeToWait = vpr::Interval::NoTimeout);

   vpr::ReturnStatus signal()
   {
      // ASSERT:  We have been locked
      if ( pthread_cond_signal(&mCondVar) == 0 )
      {
         return vpr::ReturnStatus(vpr::ReturnStatus::Succeed);
      }
      else
      {
         return vpr::ReturnStatus(vpr::ReturnStatus::Fail);
      }
   }

   vpr::ReturnStatus broadcast()
   {
      // ASSERT:  We have been locked

      // If not locked ...
      if ( mCondMutex->test() == 0 )
      {
         std::cerr << "vpr::CondVarPosix::broadcast: Mutex was not locked when "
                   << "broadcast called!!!\n";
      }

      if ( pthread_cond_broadcast(&mCondVar) == 0 )
      {
         return vpr::ReturnStatus(vpr::ReturnStatus::Succeed);
      }
      else
      {
         return vpr::ReturnStatus(vpr::ReturnStatus::Fail);
      }
   }

   vpr::ReturnStatus acquire()
   {
      return mCondMutex->acquire();
   }

   vpr::ReturnStatus tryAcquire()
   {
      return mCondMutex->tryAcquire();
   }

   vpr::ReturnStatus release()
   {
      return mCondMutex->release();
   }

   void setMutex(vpr::MutexPosix* mutex)
   {
      // NOT exactly correct, but just make sure not to leave it locked
      mutex->release();
      mCondMutex = mutex;
   }

   int test()
   {
      return mCondMutex->test();
   }

   void dump() const
   {
      std::cerr << "------------- vpr::CondVarPosix::Dump ---------\n"
                << "Not Implemented yet.\n";
   }

private:
   pthread_cond_t mCondVar;      
   MutexPosix*    mCondMutex;    
   MutexPosix     mDefaultMutex; 
   // = Prevent assignment and initialization.
   void operator= (const CondVarPosix&) {;}
   CondVarPosix(const CondVarPosix&) {;}
};

} // End of vpr namespace


#endif  /* _VPR_COND_POSIX_H_ */

---