network-monitor.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx 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, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx 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 Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 *
 * @author Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 * @author Davide Pesavento <davide.pesavento@lip6.fr>
 */
 
#ifndef NDN_CXX_NET_NETWORK_MONITOR_HPP
#define NDN_CXX_NET_NETWORK_MONITOR_HPP
 
#include "ndn-cxx/detail/asio-fwd.hpp"
#include "ndn-cxx/net/network-interface.hpp"
#include "ndn-cxx/util/signal/emit.hpp"
#include "ndn-cxx/util/signal/signal.hpp"
 
#include <vector>
 
namespace ndn::net {
 
class NetworkMonitorImpl;
 
class NetworkMonitor : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  explicit
  NetworkMonitor(boost::asio::io_context& ioCtx);
 
  enum Capability : uint32_t {
    CAP_NONE = 0,
    CAP_ENUM = 1 << 0,
    CAP_IF_ADD_REMOVE = 1 << 1,
    CAP_STATE_CHANGE = 1 << 2,
    CAP_MTU_CHANGE = 1 << 3,
    CAP_ADDR_ADD_REMOVE = 1 << 4
  };
 
  uint32_t
  getCapabilities() const;
 
  shared_ptr<const NetworkInterface>
  getNetworkInterface(const std::string& ifname) const;
 
  [[nodiscard]] std::vector<shared_ptr<const NetworkInterface>>
  listNetworkInterfaces() const;
 
protected:
  explicit
  NetworkMonitor(unique_ptr<NetworkMonitorImpl> impl);
 
  NetworkMonitorImpl&
  getImpl()
  {
    return *m_impl;
  }
 
private:
  const unique_ptr<NetworkMonitorImpl> m_impl;
  // Intentional violation of code-style rule 1.4: m_impl must be assigned before its signals can
  // be assigned to references below.
 
public: // signals
  signal::Signal<NetworkMonitorImpl>& onEnumerationCompleted;
 
  signal::Signal<NetworkMonitorImpl, shared_ptr<const NetworkInterface>>& onInterfaceAdded;
 
  signal::Signal<NetworkMonitorImpl, shared_ptr<const NetworkInterface>>& onInterfaceRemoved;
 
  signal::Signal<NetworkMonitorImpl>& onNetworkStateChanged;
};
 
class NetworkMonitorImpl : noncopyable
{
public:
  using Error = NetworkMonitor::Error;
 
  virtual
  ~NetworkMonitorImpl() = default;
 
  virtual uint32_t
  getCapabilities() const = 0;
 
  virtual shared_ptr<const NetworkInterface>
  getNetworkInterface(const std::string&) const = 0;
 
  virtual std::vector<shared_ptr<const NetworkInterface>>
  listNetworkInterfaces() const = 0;
 
protected:
  static shared_ptr<NetworkInterface>
  makeNetworkInterface();
 
public:
  signal::Signal<NetworkMonitorImpl> onEnumerationCompleted;
  signal::Signal<NetworkMonitorImpl, shared_ptr<const NetworkInterface>> onInterfaceAdded;
  signal::Signal<NetworkMonitorImpl, shared_ptr<const NetworkInterface>> onInterfaceRemoved;
  signal::Signal<NetworkMonitorImpl> onNetworkStateChanged;
 
protected:
  DECLARE_SIGNAL_EMIT(onEnumerationCompleted)
  DECLARE_SIGNAL_EMIT(onInterfaceAdded)
  DECLARE_SIGNAL_EMIT(onInterfaceRemoved)
  DECLARE_SIGNAL_EMIT(onNetworkStateChanged)
};
 
} // namespace ndn::net
 
#endif // NDN_CXX_NET_NETWORK_MONITOR_HPP