net: move network-related files to src/net
Some namespaces are changed:
* ndn::util::FaceUri is now ndn::FaceUri
* ndn::util::ethernet is now ndn::ethernet
* ndn::util::NetworkMonitor and related classes are now in ndn::net
refs #3940
Change-Id: Ia4754caef9726efc73f5a303cec46fc95c744d70
diff --git a/src/net/face-uri.hpp b/src/net/face-uri.hpp
new file mode 100644
index 0000000..12276cd
--- /dev/null
+++ b/src/net/face-uri.hpp
@@ -0,0 +1,197 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2017 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_NET_FACE_URI_HPP
+#define NDN_NET_FACE_URI_HPP
+
+#include "ethernet.hpp"
+#include "../util/time.hpp"
+
+#include <boost/asio/ip/tcp.hpp>
+#include <boost/asio/ip/udp.hpp>
+#include <boost/asio/local/stream_protocol.hpp>
+
+namespace ndn {
+
+/** \brief represents the underlying protocol and address used by a Face
+ * \sa https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#FaceUri
+ */
+class FaceUri
+{
+public:
+ class Error : public std::invalid_argument
+ {
+ public:
+ explicit
+ Error(const std::string& what)
+ : std::invalid_argument(what)
+ {
+ }
+ };
+
+ FaceUri();
+
+ /** \brief construct by parsing
+ *
+ * \param uri scheme://host[:port]/path
+ * \throw FaceUri::Error if URI cannot be parsed
+ */
+ explicit
+ FaceUri(const std::string& uri);
+
+ // This overload is needed so that calls with string literal won't be
+ // resolved to boost::asio::local::stream_protocol::endpoint overload.
+ explicit
+ FaceUri(const char* uri);
+
+ /// exception-safe parsing
+ bool
+ parse(const std::string& uri);
+
+public: // scheme-specific construction
+ /// construct udp4 or udp6 canonical FaceUri
+ explicit
+ FaceUri(const boost::asio::ip::udp::endpoint& endpoint);
+
+ /// construct tcp4 or tcp6 canonical FaceUri
+ explicit
+ FaceUri(const boost::asio::ip::tcp::endpoint& endpoint);
+
+ /// construct tcp canonical FaceUri with custom scheme
+ FaceUri(const boost::asio::ip::tcp::endpoint& endpoint, const std::string& scheme);
+
+#ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
+ /// construct unix canonical FaceUri
+ explicit
+ FaceUri(const boost::asio::local::stream_protocol::endpoint& endpoint);
+#endif // BOOST_ASIO_HAS_LOCAL_SOCKETS
+
+ /// create fd FaceUri from file descriptor
+ static FaceUri
+ fromFd(int fd);
+
+ /// construct ether canonical FaceUri
+ explicit
+ FaceUri(const ethernet::Address& address);
+
+ /// create dev FaceUri from network device name
+ static FaceUri
+ fromDev(const std::string& ifname);
+
+ /// create udp4 or udp6 NIC-associated FaceUri from endpoint and network device name
+ static FaceUri
+ fromUdpDev(const boost::asio::ip::udp::endpoint& endpoint, const std::string& ifname);
+
+public: // getters
+ /// get scheme (protocol)
+ const std::string&
+ getScheme() const
+ {
+ return m_scheme;
+ }
+
+ /// get host (domain)
+ const std::string&
+ getHost() const
+ {
+ return m_host;
+ }
+
+ /// get port
+ const std::string&
+ getPort() const
+ {
+ return m_port;
+ }
+
+ /// get path
+ const std::string&
+ getPath() const
+ {
+ return m_path;
+ }
+
+ /// write as a string
+ std::string
+ toString() const;
+
+public: // EqualityComparable concept
+ bool
+ operator==(const FaceUri& rhs) const;
+
+ bool
+ operator!=(const FaceUri& rhs) const;
+
+public: // canonical FaceUri
+ /** \return whether a FaceUri of the scheme can be canonized
+ */
+ static bool
+ canCanonize(const std::string& scheme);
+
+ /** \brief determine whether this FaceUri is in canonical form
+ * \return true if this FaceUri is in canonical form,
+ * false if this FaceUri is not in canonical form or
+ * or it's undetermined whether this FaceUri is in canonical form
+ */
+ bool
+ isCanonical() const;
+
+ typedef function<void(const FaceUri&)> CanonizeSuccessCallback;
+ typedef function<void(const std::string& reason)> CanonizeFailureCallback;
+
+ /** \brief asynchronously convert this FaceUri to canonical form
+ * \param onSuccess function to call after this FaceUri is converted to canonical form
+ * \note A new FaceUri in canonical form will be created; this FaceUri is unchanged.
+ * \param onFailure function to call if this FaceUri cannot be converted to canonical form
+ * \param io reference to `boost::asio::io_service` instance
+ * \param timeout maximum allowable duration of the operations.
+ * It's intentional not to provide a default value: the caller should set
+ * a reasonable value in balance between network delay and user experience.
+ */
+ void
+ canonize(const CanonizeSuccessCallback& onSuccess,
+ const CanonizeFailureCallback& onFailure,
+ boost::asio::io_service& io,
+ time::nanoseconds timeout) const;
+
+private:
+ std::string m_scheme;
+ std::string m_host;
+ std::string m_port;
+ std::string m_path;
+ /// whether to add [] around host when writing string
+ bool m_isV6;
+
+ friend std::ostream& operator<<(std::ostream& os, const FaceUri& uri);
+};
+
+std::ostream&
+operator<<(std::ostream& os, const FaceUri& uri);
+
+} // namespace ndn
+
+#endif // NDN_NET_FACE_URI_HPP