face-uri.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,
 *                         Arizona Board of Regents,
 *                         Colorado State University,
 *                         University Pierre & Marie Curie, Sorbonne University,
 *                         Washington University in St. Louis,
 *                         Beijing Institute of Technology,
 *                         The University of Memphis.
 *
 * 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.
 */
 
#ifndef NDN_CXX_NET_FACE_URI_HPP
#define NDN_CXX_NET_FACE_URI_HPP
 
#include "ndn-cxx/detail/asio-fwd.hpp"
#include "ndn-cxx/net/ethernet.hpp"
#include "ndn-cxx/util/time.hpp"
 
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/ip/udp.hpp>
#include <boost/asio/local/stream_protocol.hpp>
#include <boost/operators.hpp>
 
namespace ndn {
 
class FaceUri : private boost::totally_ordered<FaceUri>
{
public:
  class Error : public std::invalid_argument
  {
  public:
    using std::invalid_argument::invalid_argument;
  };
 
  FaceUri();
 
  explicit
  FaceUri(const std::string& uri);
 
  explicit
  FaceUri(const char* uri);
 
  [[nodiscard]] bool
  parse(std::string_view uri);
 
public: // scheme-specific construction
  explicit
  FaceUri(const boost::asio::ip::udp::endpoint& endpoint);
 
  explicit
  FaceUri(const boost::asio::ip::tcp::endpoint& endpoint);
 
  FaceUri(const boost::asio::ip::tcp::endpoint& endpoint, std::string_view scheme);
 
#ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
  explicit
  FaceUri(const boost::asio::local::stream_protocol::endpoint& endpoint);
#endif // BOOST_ASIO_HAS_LOCAL_SOCKETS
 
  explicit
  FaceUri(const ethernet::Address& address);
 
  static FaceUri
  fromFd(int fd);
 
  static FaceUri
  fromDev(std::string_view ifname);
 
  static FaceUri
  fromUdpDev(const boost::asio::ip::udp::endpoint& endpoint, std::string_view ifname);
 
public: // getters
  const std::string&
  getScheme() const
  {
    return m_scheme;
  }
 
  const std::string&
  getHost() const
  {
    return m_host;
  }
 
  const std::string&
  getPort() const
  {
    return m_port;
  }
 
  const std::string&
  getPath() const
  {
    return m_path;
  }
 
  std::string
  toString() const;
 
public: // canonical FaceUri
  static bool
  canCanonize(const std::string& scheme);
 
  bool
  isCanonical() const;
 
  using CanonizeSuccessCallback = std::function<void(const FaceUri&)>;
  using CanonizeFailureCallback = std::function<void(const std::string& reason)>;
 
  void
  canonize(const CanonizeSuccessCallback& onSuccess,
           const CanonizeFailureCallback& onFailure,
           boost::asio::io_context& io,
           time::nanoseconds timeout) const;
 
private:
  void
  print(std::ostream& os) const;
 
private: // non-member operators
  // NOTE: the following "hidden friend" operators are available via
  //       argument-dependent lookup only and must be defined inline.
  // boost::totally_ordered provides !=, <=, >=, and > operators.
 
  friend bool
  operator==(const FaceUri& lhs, const FaceUri& rhs) noexcept
  {
    return lhs.m_isV6 == rhs.m_isV6 &&
           lhs.m_scheme == rhs.m_scheme &&
           lhs.m_host == rhs.m_host &&
           lhs.m_port == rhs.m_port &&
           lhs.m_path == rhs.m_path;
  }
 
  friend bool
  operator<(const FaceUri& lhs, const FaceUri& rhs) noexcept
  {
    return std::tie(lhs.m_scheme, lhs.m_isV6, lhs.m_host, lhs.m_port, lhs.m_path) <
           std::tie(rhs.m_scheme, rhs.m_isV6, rhs.m_host, rhs.m_port, rhs.m_path);
  }
 
  friend std::ostream&
  operator<<(std::ostream& os, const FaceUri& uri)
  {
    uri.print(os);
    return os;
  }
 
private:
  std::string m_scheme;
  std::string m_host;
  std::string m_port;
  std::string m_path;
  bool m_isV6 = false; 
};
 
} // namespace ndn
 
#endif // NDN_CXX_NET_FACE_URI_HPP