OsEvent.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _OsEvent_h_
#define _OsEvent_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsBSem.h"
#include "os/OsNotification.h"
#include "os/OsTime.h"
#include "os/OsMutex.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class OsEvent : public OsNotification
{

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */

   OsEvent(const intptr_t userData=0);

   virtual ~OsEvent();

/* ============================ MANIPULATORS ============================== */

   virtual OsStatus signal(const intptr_t eventData);
   virtual OsStatus reset(void);
   virtual OsStatus wait(const OsTime& rTimeout=OsTime::OS_INFINITY);
   virtual OsStatus setUserData(intptr_t userData);
/* ============================ ACCESSORS ================================= */

   virtual OsStatus getEventData(intptr_t& rEventData);
   virtual OsStatus getUserData(intptr_t& rUserData) const;
/* ============================ INQUIRY =================================== */

   virtual UtlBoolean isSignaled(void);

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   intptr_t  mEventData;   
   UtlBoolean mIsSignaled; 
   OsBSem    mSignalSem;   
   OsMutex   mMutex;       
   intptr_t  mUserData;    

   OsEvent(const OsEvent& rOsEvent);

   OsEvent& operator=(const OsEvent& rhs);

};

/* ============================ INLINE METHODS ============================ */

#endif  // _OsEvent_h_