vlInetAddr.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once

#include <vlutil/vlInet.h>
#include <vlutil/vlInetAddrUtils.h>
#include <vlutil/vlString.h>
#include <vlutil/vlUtilTypes.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

// Ref. RFC3513
enum DtInetIpv6Scope
{
   DtInetIpv6_Unspecified,
   DtInetIpv6_Interface  = 1,  // AKA node-local
   DtInetIpv6_LinkLocal  = 2,
   DtInetIpv6_Subnet     = 3,  // MS only, not in RFC3513
   DtInetIpv6_AdminLocal = 4,  // in RFC3513, but not used in Linux
   DtInetIpv6_SiteLocal  = 5,
   DtInetIpv6_OrgLocal   = 8,
   DtInetIpv6_Global     = 14
};

class DT_DLL_VLUTIL DtInetAddr
{
public:
    
   DtInetAddr( DtInetUtils::DtInetAddrFamily family = DtInetUtils::DtInetAddrFamily_IPv4 );

   DtInetAddr( const DtString& addrString, const DtString& netmaskString = "" );
   DtInetAddr( const char* addrString, const char* netmaskString = NULL );

   DtInetAddr( const struct sockaddr_in& addr, DtU32 netmask = 0 );
   DtInetAddr( const DtU32 addr, DtU32 netmask = 0 );

   DtInetAddr( const struct sockaddr_in6& addr, DtU32 prefixLen = 0 );

   DtInetAddr( const struct sockaddr_storage& addr, DtU32 prefixLen = 0 );

   DtInetAddr( const DtU128& addr, DtInetUtils::DtInetAddrFamily family,
      DtU32 prefixLen = 0);

   DtInetAddr( void* boostAsioIpAddress );

   virtual ~DtInetAddr( );

   DtInetAddr( const DtInetAddr& orig );

   DtInetAddr& operator=(const DtInetAddr& orig);

   virtual DtString toDtString( bool useShortForm = false ) const;

   virtual DtInetUtils::DtInetAddrFamily family() const;
   
   virtual bool isIPv4() const;
   virtual bool isIPv6() const;

   virtual void setNetmask( DtU32 mask );

   virtual DtU32 netmask() const;

   virtual void setPrefixLen( DtU64 prefixLen );

   virtual DtU64 prefix() const;

   virtual bool isMulticast() const;

   virtual bool isBroadcast() const;

   virtual bool isLoopback() const;

   virtual bool isAnyAddr() const;

   virtual const DtInetAddr* getBroadcastAddr();

   virtual const DtInetAddr* getLoopbackAddr();

   virtual int toSockaddr( struct sockaddr_in* s ) const;
   virtual int toSockaddr( struct sockaddr_in6* s ) const;

   virtual void toAddrStorage( struct sockaddr_storage* addrStor ) const;

   virtual DtU128 toU128() const;

   virtual DtU32 toULong() const;

   virtual void setScope( DtInetIpv6Scope scopeId );

   virtual DtInetIpv6Scope scope() const;

   virtual void* boostAddress();
   virtual const void* boostAddress() const;

   friend DT_DLL_VLUTIL bool operator==( const DtInetAddr& addr1, const DtInetAddr& addr2 ); 
   friend DT_DLL_VLUTIL bool operator!=( const DtInetAddr& addr1, const DtInetAddr& addr2 );
   friend DT_DLL_VLUTIL bool operator<( const DtInetAddr& addr1, const DtInetAddr& addr2 );
   friend DT_DLL_VLUTIL bool operator>( const DtInetAddr& addr1, const DtInetAddr& addr2 );

   static const DtInetAddr& inaddrAny(DtInetUtils::DtInetAddrFamily family = DtInetUtils::DtInetAddrFamily_IPv4);
   static const DtInetAddr& loopbackAddress(DtInetUtils::DtInetAddrFamily family = DtInetUtils::DtInetAddrFamily_IPv4);

protected:
   void init();
   void initFromStrings(const char* addrString, const char* netmaskString);

protected:

#ifdef DtDIAGNOSTIC
   DtString myAddressStr;
#endif

   void* myAddr;
   
   DtU64 myIpv4Netmask;
   DtU64 myPrefixLen;

   DtInetAddr* myBroadcastAddr;
   DtInetAddr* myLoopbackAddr;

   bool myIsBroadcast;
   bool myIsMulticast;
   bool myIsLoopback;
   bool myIsAnyAddr;

   DtInetIpv6Scope myIpv6ScopeId;

}; 
// end of class DtInetAddr

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif