SipContactDb.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 _SipContactDb_h_
#define _SipContactDb_h_

// SYSTEM INCLUDES
//#include <...>
#include <utl/UtlString.h>
#include <utl/UtlHashMap.h>
#include <os/OsMutex.h>
#include <os/OsSocket.h>
#include "tapi/sipXtapi.h"

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



// FORWARD DECLARATIONS

class SipContactDb
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */
    SipContactDb();

    virtual
    ~SipContactDb();

    const bool addContact(SIPX_CONTACT_ADDRESS& contact);


    const bool updateContact(SIPX_CONTACT_ADDRESS& contact);

    const bool deleteContact(const SIPX_CONTACT_ID id);
    
    SIPX_CONTACT_ADDRESS* find(SIPX_CONTACT_ID id);

        SIPX_CONTACT_ADDRESS* find(const UtlString szIpAddress, const int port, SIPX_CONTACT_TYPE type);

    SIPX_CONTACT_ADDRESS* findByType(SIPX_CONTACT_TYPE type, SIPX_TRANSPORT_TYPE transportType, UtlString sCustomTransport = "") ;

    SIPX_TRANSPORT_TYPE findTransportType(const char* transportName) ;

    /*
     * Find the local contact from a contact id.
     */
    SIPX_CONTACT_ADDRESS* getLocalContact(SIPX_CONTACT_ID id) ;
    
    void getAll(SIPX_CONTACT_ADDRESS* contacts[], int& actualNum) const;
    
    
    void getAllForAdapter(const SIPX_CONTACT_ADDRESS* contacts[],
                          const char* szAdapter,
                          int& actualNum,
                          SIPX_CONTACT_TYPE typeFilter = CONTACT_ALL) const;
                                    
    const bool getRecordForAdapter(SIPX_CONTACT_ADDRESS& contact,
                                   const char* szAdapter,
                                   const SIPX_CONTACT_TYPE contactFilter) const;

    const bool getRecordForAdapter(SIPX_CONTACT_ADDRESS& contact,
                                   const char* szAdapter,
                                   const SIPX_CONTACT_TYPE contactFilter,
                                   const SIPX_TRANSPORT_TYPE transportFilter) const;

    
    void replicateForTransport(const SIPX_TRANSPORT_TYPE originalTransport, 
                               const SIPX_TRANSPORT_TYPE newTransport,
                               const char* szTransport,
                               const char* szRoutingID);

    void removeForTransport(const SIPX_TRANSPORT_TYPE transport);

    void dump(UtlString& output) ;

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

    void enableTurn(bool bEnable) ;


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


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


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



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

    SipContactDb(const SipContactDb& rSipContactDb);

    //** Disabled assignment operator */
    SipContactDb& operator=(const SipContactDb& rhs);
    
    const bool isDuplicate(const SIPX_CONTACT_ID id);
    
    const bool isDuplicate(const UtlString& ipAddress, const int port, SIPX_CONTACT_TYPE type, SIPX_TRANSPORT_TYPE transportType);

    const bool assignContactId(SIPX_CONTACT_ADDRESS& contact);

    UtlHashMap mContacts;   

    int mNextContactId;
    
    mutable OsMutex mLock;

    bool mbTurnEnabled ;
};

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

#endif  // _SipContactDb_h_