SipDialogMgr.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.
//
// $$
// Author: Dan Petrie (dpetrie AT SIPez DOT com)

#ifndef _SipDialogMgr_h_
#define _SipDialogMgr_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES

#include <os/OsDefs.h>
#include <os/OsMutex.h>
#include <utl/UtlString.h>
#include <utl/UtlHashBag.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// FORWARD DECLARATIONS
class SipMessage;
class SipDialog;

// TYPEDEFS


class SipDialogMgr
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

    SipDialogMgr();


    virtual
    ~SipDialogMgr();


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

    UtlBoolean createDialog(const SipMessage& message, 
                            UtlBoolean messageIsFromLocalSide,
                            const char* dialogHandle = NULL);


    UtlBoolean updateDialog(const SipMessage& message, 
                            const char* dialogHandle = NULL);

    UtlBoolean deleteDialog(const char* dialogHandle);



    UtlBoolean setNextLocalTransactionInfo(SipMessage& request,
                                           const char* method = NULL,
                                           const char* dialogHandle = NULL);

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


    UtlBoolean getEarlyDialogHandleFor(const char* establishedDialogHandle, 
                                       UtlString& earlyDialogHandle);

    UtlBoolean getEstablishedDialogHandleFor(const char* earlyDialogHandle,
                                             UtlString& establishedDialogHandle);

    int countDialogs() const;

    int toString(UtlString& dumpString);

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


    UtlBoolean earlyDialogExists(const char* earlyDialogHandle);


    UtlBoolean earlyDialogExistsFor(const char* establishedDialogHandle);


    UtlBoolean dialogExists(const char* dialogHandle);

    UtlBoolean isLastLocalTransaction(const SipMessage& message, 
                                      const char* dialogHandle = NULL);


    UtlBoolean isNewRemoteTransaction(const SipMessage& sipMessage);

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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    SipDialogMgr(const SipDialogMgr& rSipDialogMgr);

    SipDialogMgr& operator=(const SipDialogMgr& rhs);


    SipDialog* findDialog(UtlString& dialogHandle,
                          UtlBoolean ifHandleEstablishedFindEarlyDialog,
                          UtlBoolean ifHandleEarlyFindEstablishedDialog);


    SipDialog* findDialog(UtlString& callId,
                          UtlString& localTag,
                          UtlString& remoteTag,
                          UtlBoolean ifHandleEstablishedFindEarlyDialog,
                          UtlBoolean ifHandleEarlyFindEstablishedDialog);

    void lock();

    void unlock();

    OsMutex mDialogMgrMutex;
    UtlHashBag mDialogs; 
};

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

#endif  // _SipDialogMgr_h_