MulticastReceiver.h

Go to the documentation of this file.

// This file is part of CoreLibrary containing useful reusable utility
// classes.
//
// Copyright (C) 2014 to present, Duncan Crutchley
// Contact <dac1976github@outlook.com>
//
// This program 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, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 and GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// and GNU Lesser General Public License along with this program. If
// not, see <http://www.gnu.org/licenses/>.

#ifndef MULTICASTRECEIVER
#define MULTICASTRECEIVER

#include <mutex>
#include "IoContextThreadGroup.h"
#include "Threads/SyncEvent.h"

namespace core_lib
{
namespace asio
{
namespace udp
{

class CORE_LIBRARY_DLL_SHARED_API MulticastReceiver final
{
public:
    MulticastReceiver() = delete;
    MulticastReceiver(boost_iocontext_t& ioContext, const defs::connection_t& multicastConnection,
                      const defs::check_bytes_left_to_read_t& checkBytesLeftToRead,
                      const defs::message_received_handler_t& messageReceivedHandler,
                      const std::string&                      interfaceAddress = "",
                      size_t receiveBufferSize = DEFAULT_UDP_BUF_SIZE);
    MulticastReceiver(const defs::connection_t&               multicastConnection,
                      const defs::check_bytes_left_to_read_t& checkBytesLeftToRead,
                      const defs::message_received_handler_t& messageReceivedHandler,
                      const std::string&                      interfaceAddress = "",
                      size_t receiveBufferSize = DEFAULT_UDP_BUF_SIZE);
    MulticastReceiver(const MulticastReceiver&) = delete;
    MulticastReceiver& operator=(const MulticastReceiver&) = delete;
    MulticastReceiver(MulticastReceiver&&) = delete;
    MulticastReceiver& operator=(MulticastReceiver&&) = delete;
    ~MulticastReceiver();
    defs::connection_t MulticastConnection() const;
    std::string InterfaceAddress() const;
    void CloseSocket();

private:
    void CreateMulticastSocket(size_t receiveBufferSize);
    void StartAsyncRead();
    void ReadComplete(const boost_sys::error_code& error, size_t bytesReceived);
    void SetClosing(bool closing);
    bool IsClosing() const;
    void ProcessCloseSocket();

private:
    mutable std::mutex m_closingMutex{};
    threads::SyncEvent m_closedEvent{};
    bool m_closing{false};
    std::unique_ptr<IoContextThreadGroup> m_ioThreadGroup{};
    boost_iocontext_t::strand m_strand;
    defs::connection_t m_multicastConnection{};
    std::string m_interfaceAddress{};
    defs::check_bytes_left_to_read_t m_checkBytesLeftToRead{};
    defs::message_received_handler_t m_messageReceivedHandler{};
    defs::char_buffer_t m_receiveBuffer{};
    defs::char_buffer_t m_messageBuffer{};
    boost_udp_t::endpoint m_senderEndpoint{};
    boost_udp_t::socket m_socket;
};

} // namespace udp
} // namespace asio
} // namespace core_lib

#endif // MULTICASTRECEIVER