mn_basic_multicast_ip_socket.hpp

Go to the documentation of this file.

/*
*This file is part of the Mini Thread Library (https://github.com/RoseLeBlood/MiniThread ).
*Copyright (c) 2018 Amber-Sophia Schroeck
*
*The Mini Thread Library is free software; you can redistribute it and/or modify
*it under the terms of the GNU Lesser General Public License as published by
*the Free Software Foundation, version 3, or (at your option) any later version.
 
*The Mini Thread Library is distributed in the hope that it will be useful, but
*WITHOUT ANY WARRANTY; without even the implied warranty of
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*General Public License for more details.
*
*You should have received a copy of the GNU Lesser General Public
*License along with the Mini Thread  Library; if not, see
*<https://www.gnu.org/licenses/>.
*/
#ifndef __MINILIB_BASIC_MULTICAST_IP_SOCKET_H__
#define __MINILIB_BASIC_MULTICAST_IP_SOCKET_H__
 
#include "../mn_config.hpp"
#include "mn_basic_dgram_socket.hpp"
 
namespace mn {
    namespace net {
        class basic_multicast_ip_socket : public basic_dgram_ip_socket {
        public:
            using self_typ = basic_multicast_ip_socket;
            using base_type = basic_dgram_ip_socket;
 
            using endpoint_type = typename base_type::endpoint_type;
            using ipaddress_type = typename base_type::ipaddress_type;
            using handle_type = typename base_type::handle_type;
 
            basic_multicast_ip_socket()
                : base_type() { }
 
            int join_group(const ipaddress_type& groupAddress,
                           const ipaddress_type& infAddress = MNNET_IPV4_ADDRESS_ANY);
 
            int leave_group();
 
            int leave_group(const ipaddress_type& groupAddress,
                            const ipaddress_type& infAddress = MNNET_IPV4_ADDRESS_ANY);
 
            void        set_loopback(bool flag);
 
            void        set_time_to_live(int value);
 
            void        set_interface(const ipaddress_type& infAddress);
 
            bool        get_loopback();
 
            int         get_time_to_live();
 
            ipaddress_type  get_interface();
 
            virtual void swap(self_typ& rhs) noexcept {
                base_type::swap(rhs);
                m_ipMulticast.swap(rhs.m_ipMulticast);
            }
        protected:
            basic_multicast_ip_socket(handle_type& hndl, endpoint_type* endp = nullptr)
                : base_type(hndl, endp) { }
            basic_multicast_ip_socket(const protocol_type& protocol)
                : base_type(protocol) { }
        private:
            ipaddress_type m_ipMulticast;
        };
 
    #if MN_THREAD_CONFIG_NET_IPADDRESS6_ENABLE == MN_THREAD_CONFIG_YES
        class basic_multicast_ip6_socket : public basic_dgram_ip6_socket {
        public:
            using self_typ = basic_multicast_ip6_socket;
            using base_type = basic_dgram_ip6_socket;
 
            using endpoint_type = typename base_type::endpoint_type;
            using ipaddress_type = typename base_type::ipaddress_type;
            using handle_type = typename base_type::handle_type;
 
            basic_multicast_ip6_socket()
                : base_type() { }
 
            int join_group(const ipaddress_type& groupAddress, const uint8_t& uiInterface);
 
            int leave_group();
 
            int leave_group(const ipaddress_type& groupAddress, const uint8_t& uiInterface);
 
            void        set_loopback(bool flag);
 
            void        set_time_to_live(int value);
 
            void        set_interface(const uint8_t& infAddress);
 
            bool        get_loopback();
 
            int         get_time_to_live();
 
            uint8_t get_interface();
 
            virtual void swap(self_typ& rhs) noexcept {
                base_type::swap(rhs);
                m_ipMulticast.swap(rhs.m_ipMulticast);
            }
        protected:
            basic_multicast_ip6_socket(handle_type& hndl, endpoint_type* endp = nullptr)
                : base_type(hndl, endp) { }
            basic_multicast_ip6_socket(const protocol_type& protocol)
                : base_type(protocol) { }
        private:
            ipaddress_type m_ipMulticast;
        };
    #endif // MN_THREAD_CONFIG_NET_IPADDRESS6_ENABLE
 
 
 
 
    #if LWIP_UDP && LWIP_UDPLITE
        class basic_multicast_lite_ip_socket : public basic_multicast_ip_socket {
        public:
            using self_typ = basic_multicast_lite_ip_socket;
            using base_type = basic_multicast_ip_socket;
 
            using endpoint_type = typename base_type::endpoint_type;
            using ipaddress_type = typename base_type::ipaddress_type;
            using handle_type = typename base_type::handle_type;
 
            basic_dgramlite_ip_socket() : base_type(protocol_type::udp_lite) { }
 
            virtual void swap(self_typ& rhs) noexcept {
                base_type::swap(rhs);
            }
        };
    #endif
    }
}
 
#endif // __MINILIB_BASIC_MULTICAST_IP_SOCKET_H__