Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages | Examples

ArMutex.h

00001 /*
00002 MobileRobots Advanced Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004, 2005 ActivMedia Robotics LLC
00004 Copyright (C) 2006, 2007 MobileRobots Inc.
00005 
00006      This program is free software; you can redistribute it and/or modify
00007      it under the terms of the GNU General Public License as published by
00008      the Free Software Foundation; either version 2 of the License, or
00009      (at your option) any later version.
00010 
00011      This program is distributed in the hope that it will be useful,
00012      but WITHOUT ANY WARRANTY; without even the implied warranty of
00013      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014      GNU General Public License for more details.
00015 
00016      You should have received a copy of the GNU General Public License
00017      along with this program; if not, write to the Free Software
00018      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019 
00020 If you wish to redistribute ARIA under different terms, contact 
00021 MobileRobots for information about a commercial version of ARIA at 
00022 robots@mobilerobots.com or 
00023 MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 */
00025 
00026 #ifndef ARMUTEX_H
00027 #define ARMUTEX_H
00028 
00029 #ifndef WIN32
00030 #include <pthread.h>
00031 #endif
00032 #include <string>
00033 #include "ariaTypedefs.h"
00034 
00035 
00037 
00045 class ArMutex
00046 {
00047 public:
00048 
00049 #ifdef WIN32
00050   typedef HANDLE MutexType;
00051 #else
00052   typedef pthread_mutex_t MutexType;
00053 #endif
00054 
00055   typedef enum {
00056     STATUS_FAILED_INIT=1, 
00057     STATUS_FAILED, 
00058     STATUS_ALREADY_LOCKED 
00059   } Status;
00060 
00062   AREXPORT ArMutex();
00064   AREXPORT virtual ~ArMutex();
00065 
00067   AREXPORT virtual int lock();
00069   AREXPORT virtual int tryLock();
00071   AREXPORT virtual int unlock();
00073   AREXPORT virtual const char * getError(int messageNumber) const;
00075   AREXPORT void setLog(bool log) { myLog = log; } 
00077   AREXPORT void setLogName(const char *logName) { myLogName = logName; } 
00079   AREXPORT virtual MutexType & getMutex() {return(myMutex);}
00080 
00081 protected:
00082 
00083   bool myFailedInit;
00084   MutexType myMutex;
00085   ArStrMap myStrMap;
00086   bool myLog;
00087   std::string myLogName;
00088 };
00089 
00090 
00091 #endif // ARMUTEX_H

Generated on Tue Feb 20 10:51:40 2007 for Aria by  doxygen 1.4.0