BSDSocketAddress.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_BSDSocketAddress_
#define HH_SENF_Socket_Protocols_BSDSocketAddress_ 1

// Custom includes
#include <iosfwd>
#include <sys/socket.h>
#include <boost/type_traits/alignment_of.hpp>
#include <boost/type_traits/type_with_alignment.hpp>
#include <boost/operators.hpp>
#include <senf/Utils/safe_bool.hh>

//#include "BSDSocketAddress.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    class BSDSocketAddress
        : public senf::comparable_safe_bool<BSDSocketAddress>,
          public boost::less_than_comparable<BSDSocketAddress>,
          public boost::equality_comparable<BSDSocketAddress>
    {
    public:
        bool operator==(BSDSocketAddress const & other) const; 

        bool operator<(BSDSocketAddress const & other) const; 

        bool boolean_test() const;      

        short family() const;           

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

        struct sockaddr const * sockaddr_p() const;
        socklen_t socklen() const;
        socklen_t const * socklen_p() const;

        //\}

    protected:
        BSDSocketAddress(socklen_t len, short family);
        BSDSocketAddress(BSDSocketAddress const & other);
        BSDSocketAddress & operator=(BSDSocketAddress const & other);

        struct sockaddr * sockaddr_p();
        socklen_t * socklen_p();

        void socklen(socklen_t len);

    private:
        // The following incantation is needed to fix the alignment of the sockaddr data members
        // which will be added by the derived classes later: The alignment must be forced
        // to coincide with the struct sockaddr_storage alignment (which must have the largest
        // alignment of all sockaddr types).
        union {
            socklen_t len_;
            boost::type_with_alignment<boost::alignment_of<struct sockaddr_storage>::value> a_;
            char _b[boost::alignment_of<struct sockaddr_storage>::value];
        };
    };

    template <class Target>
    Target & sockaddr_cast(BSDSocketAddress & source);

    template <class Target>
    Target const & sockaddr_cast(BSDSocketAddress const & source);

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

    class GenericBSDSocketAddress
        : public BSDSocketAddress
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        //\{

        GenericBSDSocketAddress();
        GenericBSDSocketAddress(BSDSocketAddress const & other);
        GenericBSDSocketAddress& operator=(const BSDSocketAddress & other);

        GenericBSDSocketAddress(const GenericBSDSocketAddress& other);
        GenericBSDSocketAddress& operator=(const GenericBSDSocketAddress& other);

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

        struct sockaddr const * sockaddr_p() const;
        struct sockaddr * sockaddr_p();

        using BSDSocketAddress::socklen_p;

        //\}

    protected:

    private:
        struct sockaddr_storage addr_;
    };

}

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