INet6Address.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_INet6Address_
#define HH_SENF_Socket_Protocols_INet_INet6Address_ 1

// Custom includes
#include <string>
#include <netinet/in.h>
#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.hh"

//#include "INet6Address.mpp"
#include "INet6Address.ih"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    struct EUI64;
    struct MACAddress;
    class INet6Network;

    class INet6Address
        : public boost::array<boost::uint8_t,16>,
          public comparable_safe_bool<INet6Address>
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        static INet6Address const None;        
        static INet6Address const Loopback;    
        static INet6Address const AllNodes;    
        static INet6Address const AllRouters;  

        enum Resolve_t { ResolveINet6, ResolveINet4 };

        enum ScopeId {
              InterfaceScope    =  1    
            , LinkScope         =  2    
            , AdminScope        =  4    
            , SiteScope         =  5    
            , OrganizationScope =  8    
            , GlobalScope       = 14    
            , ReservedScope     =  0    
            , UnassignedScope   =  6    
        };

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

        explicit INet6Address(senf::NoInit_t); 
        explicit INet6Address(boost::uint16_t a0=0u, boost::uint16_t a1=0u, boost::uint16_t a2=0u,
                              boost::uint16_t a3=0u, boost::uint16_t a4=0u, boost::uint16_t a5=0u,
                              boost::uint16_t a6=0u, boost::uint16_t a7=0u);

        static INet6Address from_in6addr(in6_addr const & in6addr); 

        static INet6Address from_string(std::string const & s, Resolve_t resolve = ResolveINet6);

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

        static INet6Address from_inet4address(INet4Address const & addr);

        static INet6Address from_mac(MACAddress const & mac);

        static INet6Address from_eui64(EUI64 const & eui);

        in6_addr toin6_addr() const;    

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

        INet6Network network() const; 
        bool hasEUI64() const;          
        EUI64 id() const;               
        bool universalId() const;       
        bool groupId() const;           

        bool unicast() const;           
        bool multicast() const;         

        ScopeId scope() const;          

        bool globalScope() const;       
        bool linkScope() const;         

        INet4Address inet4address() const; 

        bool inet4Compatible() const;   

        bool inet4Mapped() const;       

        bool globalMulticastAddr() const; 

        bool prefixMulticastAddr() const; 

        bool embeddedRpAddr() const;    

        bool boolean_test() const;      

        //\}
        //\{

        void network(boost::uint64_t net); 
        void id(boost::uint64_t id);    

        //\}

    };

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

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

    template <unsigned a0, unsigned a1, unsigned a2=0u, unsigned a3=0u, unsigned a4=0u,
              unsigned a5=0u, unsigned a6=0u, unsigned a7=0u, unsigned a8=0u>
    struct CheckINet6Network
#ifndef DOXYGEN
        : public detail::CheckINet6Network_impl<a0,a1,a2,a3,a4,a5,a6,a7,a8>
#endif
    {};

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

        INet6Network();                 
        INet6Network(INet6Address const & address, unsigned prefix_len);
        explicit INet6Network(std::string const & s); 

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

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

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

        bool match(INet6Address const & addr) const; 
        bool match(INet6Network const & net) const; 

        INet6Address host(boost::uint64_t id); 

        INet6Network subnet(boost::uint64_t net, unsigned prefix_len);

    protected:

    private:
        unsigned prefix_len_;
        INet6Address address_;

        unsigned prefix_len_checked(unsigned prefix_len) const;
    };

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

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

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "INet6Address.cci"
#include "INet6Address.ct"
#include "INet6Address.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: