gxPlatformHelper Class Reference

Encapsulates platform-specific utilities, such as threads, synchronization objects etc. More...

#include <gxPlatformHelper.h>

List of all members.

Public Member Functions
	gxPlatformHelper ()
virtual	~gxPlatformHelper ()
Static Public Member Functions
static int	newMutex (void **mutex)
	Create a new mutex (or platform specific alternative) and return as a void pointer.
static int	deleteMutex (void *mutex)
static int	lockMutex (void *mutex)
static int	unlockMutex (void *mutex)
static int	newEvent (void **event)
static int	deleteEvent (void *event)
static int	signalEvent (void *event)
static int	waitForEvent (void *event, long time)
static std::string	getModuleFileName ()
static std::string	getAppDataFolder ()
static int	ensureFolderExists (gxPath &folderPath)
	verify that the folder exists - if not create it, including any intermediate folders that may also be missing

---

Detailed Description

Encapsulates platform-specific utilities, such as threads, synchronization objects etc.

Most methods return a numeric result, typedef'd as gxPlatformHelper::int. For all platforms, a result of 0 means success, and a non-zero value means that some type of error occurred.

Acknowledgements:

• Apache Software Foundation (Xerces) - the design of this class is based on XMLPlatformUtils. I like their idea of simply using "void *" to represent all platform specific structures, rather than coming up with a slew of typedefs.
• Large Scale C++ Software Design (9.1.8) - for the advice that "0 means success, non-zero means failure" is good enough for most clients. This leads to an implementation where on failure, the method returns the OS-specific error code directly. "File not found" will return different values on Linux and Windows - and that's OK. The alternative is to come up with a massive enumeration of every possible error that might occur on all supported platforms and map the os-code to the enum value - IMO its not worth the effort and added complexity.

---

Constructor & Destructor Documentation

gxPlatformHelper::gxPlatformHelper (   )

virtual gxPlatformHelper::~gxPlatformHelper (   )  [virtual]

---

Member Function Documentation

static int gxPlatformHelper::deleteEvent (  void *  event  )  [static]

static int gxPlatformHelper::deleteMutex (  void *  mutex  )  [static]

static int gxPlatformHelper::ensureFolderExists (  gxPath &  folderPath  )  [static]

verify that the folder exists - if not create it, including any intermediate folders that may also be missing

static std::string gxPlatformHelper::getAppDataFolder (   )  [static]

static std::string gxPlatformHelper::getModuleFileName (   )  [static]

static int gxPlatformHelper::lockMutex (  void *  mutex  )  [static]

static int gxPlatformHelper::newEvent (  void **  event  )  [static]

static int gxPlatformHelper::newMutex (  void **  mutex  )  [static]

Create a new mutex (or platform specific alternative) and return as a void pointer. The returned value should be used only by deleteMutex, lockMutex or unlockMutex methods of this class. Implementation note: On MS Windows, this object is actually a CRITICAL_SECTION .

static int gxPlatformHelper::signalEvent (  void *  event  )  [static]

static int gxPlatformHelper::unlockMutex (  void *  mutex  )  [static]

static int gxPlatformHelper::waitForEvent (  void *  event, long  time )  [static]

---

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

• gxPlatformHelper.h

---