SipDialog.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2014 SIPez LLC.  All rights reserved.
//
// 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 _SipDialog_h_
#define _SipDialog_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES

#include <os/OsDefs.h>
#include <utl/UtlHashMap.h>
#include <net/Url.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
#define DIALOG_HANDLE_SEPARATOR ','

// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class SipMessage;


class SipDialog : public UtlString
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

    enum DialogState
    {
        DIALOG_UNKNOWN,
        DIALOG_EARLY,
        DIALOG_ESTABLISHED,
        DIALOG_FAILED,
        DIALOG_TERMINATED
    };

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


    SipDialog(const SipMessage* initialMessage = NULL,
              UtlBoolean isFromLocal = TRUE);


    SipDialog(const char* callId, const char* localField, const char* remoteField); 

    virtual
    ~SipDialog();


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


    void updateDialogData(const SipMessage& message);


    void setRequestData(SipMessage& request, const char* method);

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


    void getHandle(UtlString& dialogHandle) const;

    void getEarlyHandle(UtlString& earlyDialogHandle) const;

    static void parseHandle(const char* dialogHandle,
                            UtlString& callId,
                            UtlString& localTag,
                            UtlString& remoteTag);

    static void reverseTags(const char* dialogHandle,
                            UtlString& reversedHandle);

    void getCallId(UtlString& callId) const;
    void setCallId(const char* callId);

    void getLocalField(Url& localUrl) const;
    void getLocalTag(UtlString& localTag) const;
    void setLocalField(const Url& localUrl);

    void getRemoteField(Url& remoteUrl) const;
    void getRemoteTag(UtlString& remoteTag) const;
    void setRemoteField(const Url& remoteUrl);

    void getRemoteContact(Url& remoteContact) const;
    void setRemoteContact(const Url& remoteContact);

    void getLocalContact(Url& localContact) const;
    void setLocalContact(const Url& localContact);

    void getInitialMethod(UtlString& method) const;
    void setInitialMethod(const char* method);

    int getNextLocalCseq();
    int getLastLocalCseq() const;
    void setLastLocalCseq(int seqNum);

    int getLastRemoteCseq() const;
    void setLastRemoteCseq(int seqNum);


    void getLocalRequestUri(UtlString& requestUri) const;
    void setLocalRequestUri(const UtlString& requestUri);

    void getRemoteRequestUri(UtlString& requestUri) const;
    void setRemoteRequestUri(const UtlString& requestUri);

    //int getDialogState() const;

    void toString(UtlString& dialogDumpString);

    static void getStateString(DialogState state, 
                               UtlString& stateString);

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


    UtlBoolean isSameDialog(const SipMessage& message) const;


    UtlBoolean isSameDialog(const UtlString& callId,
                            const UtlString& localTag,
                            const UtlString& remoteTag) const;


    UtlBoolean isSameDialog(const char* dialogHandle);

    UtlBoolean isEarlyDialog() const;


    static UtlBoolean isEarlyDialog(const char* dialogHandle);

    UtlBoolean isEarlyDialogFor(const SipMessage& message) const;

    UtlBoolean isEarlyDialogFor(const UtlString& callId,
                                const UtlString& localTag,
                                const UtlString& remoteTag) const;


    UtlBoolean wasEarlyDialogFor(const SipMessage& message) const;


    UtlBoolean wasEarlyDialogFor(const UtlString& callId,
                                 const UtlString& localTag,
                                 const UtlString& remoteTag) const;


    UtlBoolean isTransactionLocallyInitiated(const UtlString& callId,
                                             const UtlString& fromTag,
                                             const UtlString& toTag) const;


    UtlBoolean isTransactionRemotelyInitiated(const UtlString& callId,
                                              const UtlString& fromTag,
                                              const UtlString& toTag) const;

    UtlBoolean isSameLocalCseq(const SipMessage& message) const;

    UtlBoolean isSameRemoteCseq(const SipMessage& message) const;

    UtlBoolean isNextLocalCseq(const SipMessage& message) const;

    UtlBoolean isNextRemoteCseq(const SipMessage& message) const;

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

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    SipDialog(const SipDialog& rSipDialog);

    SipDialog& operator=(const SipDialog& rhs);

    // The callId is stored in the UtlString base class data element
    Url mLocalField; // To or From depending on who initiated the transaction
    Url mRemoteField; // To or From depending on who initiated the transaction
    UtlString mLocalTag;
    UtlString mRemoteTag;
    Url mLocalContact;
    Url mRemoteContact;
    UtlString mRouteSet;
    UtlString mInitialMethod;
    UtlString msLocalRequestUri;
    UtlString msRemoteRequestUri;
    UtlBoolean mLocalInitatedDialog;
    int mInitialLocalCseq;
    int mInitialRemoteCseq;
    int mLastLocalCseq;
    int mLastRemoteCseq;
    int mDialogState;

};

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

#endif  // _SipDialog_h_