IpAddress.h

Go to the documentation of this file.

// IpAddress.h -- interface to the IpAddress class

#ifndef IPADDRESS_H_
#define IPADDRESS_H_

#ifdef _MSC_VER
#pragma once
#endif // MSVC

#include <iosfwd>
#include <string>
#include <memory>

// platform specific header
#include "SocketIncludes.h"


// IpAddress

class IpAddress
{
public:
        // Constructors.
        IpAddress( unsigned long code = INADDR_ANY );
        IpAddress( const std::string& address );
        IpAddress( const in_addr& address );
        IpAddress( const IpAddress& address );

        // Destructor.
        ~IpAddress();

        // Assignment.
        IpAddress& operator=( const in_addr& address );
        IpAddress& operator=( const IpAddress& address );

        // Comparison.
        bool operator==( const IpAddress& address ) const;
        bool operator<( const IpAddress& address ) const;

        // Standard c++ iostream inserter
        std::ostream& operator<<( std::ostream& stream) const;

        // Conversion to a Berkley Socket in_addr structure
        operator in_addr() const;

        // Conversion of IpAddress to a long
        unsigned long toLong() const throw();

        // Accessors to set IpAddress
        void set( const std::string& string );
        void set( unsigned long code ) throw();
        void setHostName( const std::string& hostName );

        // Whether the IpAddress represents the local host
        bool isLocal() const;

        // Validity test for IpAddress
        bool isDefined() const;

        // Retrieve an IpAddress representing the local host
        static const IpAddress& getLocalIpAddress();

private:
        // Berkley Socket in_addr structure.
        struct in_addr ipAddress;

        // Collection of IpAddresses for the local host
        static std::auto_ptr<IpAddress> localIpAddress;        
};


#endif // IPADDRESS_H_

---