MulticastSocketProtocol.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_MulticastSocketProtocol_
#define HH_SENF_Socket_Protocols_INet_MulticastSocketProtocol_ 1

// Custom includes
#include <senf/Socket/SocketProtocol.hh>
#include "INet4Address.hh"
#include "INet6Address.hh"

//#include "MulticastSocketProtocol.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    //\{

    class MulticastSocketProtocol
        : public virtual SocketProtocol
    {
    public:
        void broadcastEnabled(bool v) const; 

        bool broadcastEnabled() const;  

        unsigned mcTTL() const;         
        void mcTTL(unsigned value) const; 

        bool mcLoop() const;            
        void mcLoop(bool value) const;  

        void mcIface(std::string const & iface = std::string()) const;

    };

    class INet4MulticastSocketProtocol
        : public MulticastSocketProtocol
    {
    public:
        void mcAddMembership(INet4Address const & mcAddr) const;

        void mcAddMembership(INet4Address const & mcAddr, INet4Address const & localAddr) const;

        void mcAddMembership(INet4Address const & mcAddr, std::string const & iface) const;

        void mcDropMembership(INet4Address const & mcAddr) const;

        void mcDropMembership(INet4Address const & mcAddr, INet4Address const & localAddr)
            const;

        void mcDropMembership(INet4Address const & mcAddr, std::string const & iface)
            const;

        void mcJoinSSMSource(INet4Address const & group, INet4Address const & source,
                             std::string const & iface) const;

        void mcLeaveSSMSource(INet4Address const & group, INet4Address const & source,
                              std::string const & iface) const;

    };

    class INet6MulticastSocketProtocol
        : public MulticastSocketProtocol
    {
    public:
        void mcAddMembership(INet6Address const & mcAddr) const;

        void mcAddMembership(INet6Address const & mcAddr, std::string const & iface) const;

        void mcDropMembership(INet6Address const & mcAddr) const;

        void mcDropMembership(INet6Address const & mcAddr, std::string const & iface) const;

        void mcJoinSSMSource(INet6Address const & group, INet6Address const & source,
                             std::string const & iface) const;

        void mcJoinSSMSource(INet6Address const & group, INet6Address const & source,
                             int ifacei = 0) const;

        void mcLeaveSSMSource(INet6Address const & group, INet6Address const & source,
                              std::string const & iface) const;

    };

    //\}
}

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