OsContact.h

Go to the documentation of this file.

//
// Copyright (C) 2006 Pingtel Corp.
// 
//
// $$


#ifndef _OsContact_h_
#define _OsContact_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "utl/UtlContainable.h"
#include "utl/UtlString.h"
#include "os/OsSocket.h"

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

/* ============================ ENUMERATIONS ============================== */
enum IpAddressType
{
    IP4,    
    IP6     
};

class OsContact : public UtlContainable
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ FRIENDS =================================== */
    friend class OsContactTests;
    
/* ============================ ENUMERATIONS ============================== */

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

    OsContact(UtlString address,
              int port,
              OsSocket::IpProtocolSocketType protocol,
              IpAddressType type);
                       
    OsContact(const OsContact& ref);
         
    virtual ~OsContact();


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


/* ============================ ACCESSORS ================================= */
    const void getAddress(UtlString& address) const;
    
    const int getPort() const;
    
    const OsSocket::IpProtocolSocketType getProtocol() const;
    
    const IpAddressType getAddressType() const;

    virtual unsigned hash() const ;

    virtual UtlContainableType getContainableType() const;
    
/* ============================ INQUIRY =================================== */

    virtual int compareTo(UtlContainable const *) const ;    

    virtual UtlBoolean isEqual(UtlContainable const *) const ; 

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
    static UtlContainableType TYPE ;    
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    OsContact& operator=(const OsContact&) ;
    
    const int compareInt(const int first, const int second) const;
    
    UtlString mAddress;                      
    int mPort ;                              
    OsSocket::IpProtocolSocketType mProtocol; 
    IpAddressType mType;                     
} ;

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

#endif    // _OsContact_h_