INet4Address.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Socket_Protocols_INet_INet4Address_
#define HH_SENF_Socket_Protocols_INet_INet4Address_ 1

// Custom includes
#include <string>
#include <boost/cstdint.hpp>
#include <boost/array.hpp>
#include <boost/operators.hpp>
#include <senf/Utils/safe_bool.hh>
#include <senf/Utils/Tags.hh>

//#include "INet4Address.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    class INet4Address
        : public boost::array<boost::uint8_t,4>,
          public comparable_safe_bool<INet4Address>
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef uint32_t address_type;  
        typedef uint32_t inaddr_type;   

        static INet4Address const None; 
        static INet4Address const Loopback; 
        static INet4Address const Broadcast; 

        //-////////////////////////////////////////////////////////////////////////
        //\{

        INet4Address();                 
        explicit INet4Address(senf::NoInit_t); 
        explicit INet4Address(address_type value);

        static INet4Address from_string(std::string const & s);

        template <class InputIterator>
        static INet4Address from_data(InputIterator i);

        static INet4Address from_inaddr(inaddr_type v);

        //\}
        //-////////////////////////////////////////////////////////////////////////
        //\{

        bool local() const;             

        bool loopback() const;          

        bool multicast() const;         

        bool broadcast() const;         
        bool boolean_test() const;      

        inaddr_type inaddr() const;     

        address_type address() const;   

        //-/////////////////////////////////////////////////////////////////////////////////////////

    private:
        enum InAddr_t { IsInAddr };
        INet4Address(inaddr_type addr, InAddr_t);
        inaddr_type & iref();
        inaddr_type iref() const;
    };

    std::ostream & operator<<(std::ostream & os, INet4Address const & addr);

    std::istream & operator>>(std::istream & os, INet4Address & addr);

    template <boost::uint32_t address, unsigned prefix_len>
    class CheckINet4Network
    {
    public:
        static bool match(INet4Address const & addr);
    };

    class INet4Network
        : public boost::equality_comparable<INet4Network>,
          public comparable_safe_bool<INet4Network>
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        //\{

        INet4Network();                 
        INet4Network(INet4Address const & address, unsigned prefix_len);
        explicit INet4Network(std::string const & s); 

        //\}
        //-////////////////////////////////////////////////////////////////////////

        INet4Address const & address() const; 
        unsigned prefix_len() const;    

        bool boolean_test() const;      
        bool operator==(INet4Network const & other) const;

        bool match(INet4Address const & addr) const; 
        bool match(INet4Network const & net) const; 

        INet4Address host(boost::uint32_t number); 

        INet4Network subnet(boost::uint32_t net, unsigned prefix_len);

    protected:

    private:
        boost::uint32_t mask() const;
        unsigned prefix_len_checked(unsigned prefix_len) const;

        unsigned prefix_len_;
        INet4Address address_;
    };

    std::ostream & operator<<(std::ostream & os, INet4Network const & addr);

    std::istream & operator>>(std::istream & is, INet4Network & addr);

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "INet4Address.cci"
#include "INet4Address.ct"
#include "INet4Address.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: