CSeqManager.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 _CSeqManager_h_
#define _CSeqManager_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "utl/UtlHashMap.h"
#include "utl/UtlRandom.h"
#include "utl/UtlString.h"
#include "os/OsMutex.h"

// DEFINES
#define CSEQ_MANAGER_STATE_CHECKS
#undef  CSEQ_MANAGER_STATE_CHECKS

#define CSEQ_ID_INVITE      "INVITE"
#define CSEQ_ID_INFO        "INFO"
#define CSEQ_ID_NOTIFY      "NOTIFY"
#define CSEQ_ID_REFER       "REFER"
#define CSEQ_ID_OPTIONS     "OPTIONS" 

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
typedef struct CSEQ_CONTEXT
{
    UtlString  identifier ;
    bool       bInTransaction ;
    int       iCSeq ;
} CSEQ_CONTEXT ;

// FORWARD DECLARATIONS


class CSeqManager
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
  public:

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

    CSeqManager();
     
    virtual ~CSeqManager();

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

    bool startTransaction(const char* szIdentifier, int& iCSeq) ;

    bool endTransaction(const char* szIdentifier) ;

    void dumpState(UtlString& state) ;

/* ============================ ACCESSORS ================================= */
    
    int getCSeqNumber(const char* szIdentifier) ;

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

    bool isInTransaction(const char* szIdentifier) ;

/* //////////////////////////// PROTECTED ///////////////////////////////// */
  protected:
    UtlHashMap   mHashMap ;
    UtlRandom    mRandomGenerator ;
    OsMutex      mGuard ;
    int          miCSeq ;

    CSEQ_CONTEXT* getContext(const char* szIdentifier) ;

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

    CSeqManager(const CSeqManager& rCSeqManager);     

    CSeqManager& operator=(const CSeqManager& rhs);  

};

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

#endif  // _CSeqManager_h_