blob: b58cfffdbe93099b3e840bedeac85e12684767b3 [file] [log] [blame]
Yanbiao Liac8b4ca2017-07-10 02:27:50 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2013-2017 Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
12 *
13 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
14 * terms of the GNU Lesser General Public License as published by the Free Software
15 * Foundation, either version 3 of the License, or (at your option) any later version.
16 *
17 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
19 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
20 *
21 * You should have received copies of the GNU General Public License and GNU Lesser
22 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
23 * <http://www.gnu.org/licenses/>.
24 *
25 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
26 */
27
28#ifndef NDN_NET_ADDRESS_CONVERTER_HPP
29#define NDN_NET_ADDRESS_CONVERTER_HPP
30
31#include "../common.hpp"
32
33#include <boost/asio/ip/address.hpp>
34#include <boost/system/error_code.hpp>
35
36namespace ndn {
37namespace ip {
38
39/**
40 * \brief Convert scope ID of IPv6 address into interface name
41 *
42 * \return interface name, or ndn::nullopt if \p scopeId cannot be converted
43 */
44optional<std::string>
45scopeNameFromId(unsigned int scopeId);
46
47/**
48 * \brief parse and convert the input string into an IP address
49 *
50 * \param str the string to parse
51 *
52 * \return the converted IP address
53 * \throw boost::system::system_error in case of failure
54 */
55boost::asio::ip::address
56addressFromString(const std::string& str);
57
58/**
59 * \brief parse and convert the input string into an IP address
60 *
61 * \param str the string to parse
62 * \param ec the error code of failure in conversion
63 *
64 * \return the converted IP address, or a default-constructed
65 * `boost::asio::ip::address` in case of failure
66 */
67boost::asio::ip::address
68addressFromString(const std::string& str, boost::system::error_code& ec);
69
70/**
71 * \brief parse and convert the input string into an IPv6 address
72 *
73 * \param str the string to parse
74 *
75 * \return the converted IPv6 address
76 * \throw boost::system::system_error in case of failure
77 */
78boost::asio::ip::address_v6
79addressV6FromString(const std::string& str);
80
81/**
82 * \brief parse and convert the input string into an IPv6 address
83 *
84 * \param str the string to parse
85 * \param ec the error code of failure in conversion
86 *
87 * \return the converted IPv6 address, or a default-constructed
88 * `boost::asio::ip::address_v6` in case of failure
89 */
90boost::asio::ip::address_v6
91addressV6FromString(const std::string& str, boost::system::error_code& ec);
92
93} // namespace ip
94} // namespace ndn
95
96#endif // NDN_NET_ADDRESS_CONVERTER_HPP