blob: c7e4e8f91ba1da3b5c5c8ad6643c1a567e9d2af5 [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 NFD_TESTS_UNIT_TESTS_NET_COLLECT_NETIFS_HPP
29#define NFD_TESTS_UNIT_TESTS_NET_COLLECT_NETIFS_HPP
30
31#include "common.hpp"
32#include "net/network-interface.hpp"
33
34#include <vector>
35
36namespace ndn {
37namespace net {
38namespace tests {
39
40/** \brief Collect information about network interfaces
41 * \param allowCached if true, previously collected information can be returned
42 * \note This function is blocking if \p allowCached is false or no previous information exists
43 * \throw ndn::net::NetworkMonitor::Error NetworkMonitor::CAP_ENUM is unavailable
44 */
45std::vector<shared_ptr<const NetworkInterface>>
46collectNetworkInterfaces(bool allowCached = true);
47
48} // namespace tests
49} // namespace net
50} // namespace ndn
51
52#endif // NFD_TESTS_UNIT_TESTS_NET_COLLECT_NETIFS_HPP