MpFlowGraphMsg.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2009 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 _MpFlowGraphMsg_h_
#define _MpFlowGraphMsg_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsMsg.h"

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

// FORWARD DECLARATIONS
class MpResource;

class MpFlowGraphMsg : public OsMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   typedef enum
   {
      FLOWGRAPH_ADD_LINK = 0,
      FLOWGRAPH_ADD_RESOURCE,
      FLOWGRAPH_DESTROY_RESOURCES,
      FLOWGRAPH_DISABLE,
      FLOWGRAPH_ENABLE,
      FLOWGRAPH_PROCESS_FRAME,
      FLOWGRAPH_REMOVE_CONNECTION,
      FLOWGRAPH_REMOVE_LINK,
      FLOWGRAPH_REMOVE_RESOURCE,
      FLOWGRAPH_DESTROY_RESOURCE,
      FLOWGRAPH_START,
      FLOWGRAPH_STOP,
      RESOURCE_DISABLE,
      RESOURCE_ENABLE,

      FLOWGRAPH_START_PLAY,
      FLOWGRAPH_START_TONE,

      FLOWGRAPH_STOP_PLAY,
      FLOWGRAPH_STOP_TONE,
      FLOWGRAPH_STOP_RECORD,

      FLOWGRAPH_SYNCHRONIZE,

      FLOWGRAPH_GET_LATENCY_FOR_PATH,

      RESOURCE_SPECIFIC_START = 100     
   } MpFlowGraphMsgType;

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


   MpFlowGraphMsg(int msg, MpResource* pMsgDest=NULL,
                  void* pPtr1=NULL, void* pPtr2=NULL,
                  intptr_t int1=-1, intptr_t int2=-1);

   MpFlowGraphMsg(const MpFlowGraphMsg& rMpFlowGraphMsg);

   virtual OsMsg* createCopy(void) const;

   virtual
   ~MpFlowGraphMsg();


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


   MpFlowGraphMsg& operator=(const MpFlowGraphMsg& rhs);

   void setMsgDest(MpResource* pMsgDest);
   void setPtr1(void* p);

   void setPtr2(void* p);

   void setInt1(intptr_t i);

   void setInt2(intptr_t i);


/* ============================ ACCESSORS ================================= */


   int getMsg(void) const;

   MpResource* getMsgDest(void) const;
   void* getPtr1(void) const;

   void* getPtr2(void) const;

   intptr_t getInt1(void) const;

   intptr_t getInt2(void) const;


/* ============================ INQUIRY =================================== */



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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   MpResource* mpMsgDest; 
   void*       mpPtr1;    
   void*       mpPtr2;    
   intptr_t    mInt1;     
   intptr_t    mInt2;     

};

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

#endif  // _MpFlowGraphMsg_h_