OsQueuedEvent.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 _OsQueuedEvent_h_
#define _OsQueuedEvent_h_

// SYSTEM INCLUDES

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

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

class OsQueuedEvent : public OsNotification
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

   OsQueuedEvent(OsMsgQ& rMsgQ, const intptr_t userData);

   virtual ~OsQueuedEvent();

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

   virtual OsStatus signal(const intptr_t eventData);
   virtual OsStatus setUserData(intptr_t userData);
/* ============================ ACCESSORS ================================= */

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

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

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

   intptr_t  mUserData;    
   OsMsgQ*   mpMsgQ;       

   OsStatus doSendEventMsg(const int msgType, const intptr_t eventData) const;
   OsQueuedEvent(const OsQueuedEvent& rOsQueuedEvent);

   OsQueuedEvent& operator=(const OsQueuedEvent& rhs);

};

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

#endif  // _OsQueuedEvent_h_