internetaddress.h

Go to the documentation of this file.

/*
 *  $Id: internetaddress.h 1441 2012-07-03 16:38:31Z dreibh $
 *
 * SocketAPI implementation for the sctplib.
 * Copyright (C) 1999-2012 by Thomas Dreibholz
 *
 * Realized in co-operation between
 * - Siemens AG
 * - University of Essen, Institute of Computer Networking Technology
 * - University of Applied Sciences, Muenster
 *
 * Acknowledgement
 * This work was partially funded by the Bundesministerium fuer Bildung und
 * Forschung (BMBF) of the Federal Republic of Germany (Foerderkennzeichen 01AK045).
 * The authors alone are responsible for the contents.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact: discussion@sctp.de
 *          dreibh@iem.uni-due.de
 *          tuexen@fh-muenster.de
 *
 * Purpose: Internet Address Implementation
 *
 */

#ifndef INTERNETADDRESS_H
#define INTERNETADDRESS_H


#include "tdsystem.h"
#include "strings.h"
#include "socketaddress.h"
#include "portableaddress.h"


#include <netinet/in.h>
#include <resolv.h>



class InternetAddress : virtual public SocketAddress
{
   // ====== Constructors/Destructor ========================================
   public:
   InternetAddress();

   InternetAddress(const InternetAddress& address);

   InternetAddress(const String& address);

   InternetAddress(const String& hostName,
                   const card16 port);

   InternetAddress(const card16 port);

   InternetAddress(const sockaddr* address, const socklen_t length);

   ~InternetAddress();


   // ====== Initialization =================================================
   void reset();

   SocketAddress* duplicate() const;

   void init(const InternetAddress& address);

   void init(const String& hostName, const card16 port);

   void init(const card16 port);

   void init(const sockaddr* address, const socklen_t length);


   // ====== Operators ======================================================
   inline InternetAddress& operator=(const InternetAddress& source);


   // ====== Address manipulation ===========================================
   card16 getPort() const;

   void setPort(const card16 port);


   // ====== Address functions ==============================================
   bool isValid() const;

   integer getFamily() const;

   String getAddressString(const cardinal format = PF_Default) const;

   inline bool isIPv4() const;

   inline bool isIPv4compatible() const;

   inline bool isIPv6() const;

   inline bool isNull() const;

   inline bool isUnspecified() const;

   inline bool isLoopback() const;

   inline bool isLinkLocal() const;

   inline bool isSiteLocal() const;

   inline bool isGlobal() const;

   inline bool isMulticast() const;

   inline bool isBroadcast() const;

   inline bool isUnicast() const;

   inline bool isReserved() const;

   inline bool isNodeLocalMulticast() const;

   inline bool isLinkLocalMulticast() const;

   inline bool isSiteLocalMulticast() const;

   inline bool isOrgLocalMulticast() const;

   inline bool isGlobalMulticast() const;


   // ====== Get/set system sockaddr structure ==============================
   cardinal getSystemAddress(sockaddr*       buffer,
                             const socklen_t length,
                             const cardinal  type) const;

   bool setSystemAddress(const sockaddr* address, const socklen_t length);


   // ====== IPv6 support functions ========================================
   static cardinal getHostByName(const String& name, card16* myadr, card16* myscope = NULL);

   static card16 getServiceByName(const char* name);

   static bool getFullHostName(char* str, const size_t size);

   static inline bool hasIPv6();

   static bool UseIPv6;


   // ====== Get local address for a connection =============================
   static InternetAddress getLocalAddress(const InternetAddress& peer);


    // ====== Comparision operators =========================================
   int operator==(const InternetAddress& address) const;

   inline int operator!=(const InternetAddress& address) const;

   int operator<(const InternetAddress& address) const;

   inline int operator<=(const InternetAddress& address) const;

   int operator>(const InternetAddress& address) const;

   inline int operator>=(const InternetAddress& address) const;


   // ====== Conversion from and to PortableAddress =========================
   inline PortableAddress getPortableAddress() const;

   InternetAddress(const PortableAddress& address);

   void init(const PortableAddress& address);


   // ====== System functions ===============================================
   static bool setIPv4Address(const InternetAddress& address,
                              in_addr*               ipv4Address);

   static InternetAddress getIPv4Address(const in_addr& ipv4Address);

   static card32 calculateChecksum(card8*         buffer,
                                   const cardinal bytes,
                                   card32         sum);

   static card32 wrapChecksum(card32 sum);


   // ====== Private data ===================================================
   private:
   static bool checkIPv6();


   private:
   union {
      card16   Host16[8];
      card32   Host32[4];
      in6_addr Address;
   } AddrSpec;

   card16 Port;

   card16 ScopeID;

   bool Valid;
};


#include "internetaddress.icc"


#endif