blob: e91a26bdf061322ae88207dc93a2d6bd1ff970e6 [file] [log] [blame]
Junxiao Shi38f4ce92016-08-04 10:01:52 +00001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesavento87fc0f82018-04-11 23:43:51 -04002/*
Davide Pesavento40641272023-03-16 13:31:12 -04003 * Copyright (c) 2014-2023, Regents of the University of California,
Junxiao Shi38f4ce92016-08-04 10:01:52 +00004 * 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 NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
Junxiao Shi331ade72016-08-19 14:07:19 +000026#ifndef NFD_TOOLS_NFDC_CHANNEL_MODULE_HPP
27#define NFD_TOOLS_NFDC_CHANNEL_MODULE_HPP
Junxiao Shi38f4ce92016-08-04 10:01:52 +000028
29#include "module.hpp"
30
Davide Pesavento40641272023-03-16 13:31:12 -040031#include <ndn-cxx/mgmt/nfd/channel-status.hpp>
32
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040033namespace nfd::tools::nfdc {
Junxiao Shi38f4ce92016-08-04 10:01:52 +000034
35using ndn::nfd::ChannelStatus;
36
Davide Pesavento63b3ae82023-03-24 23:53:24 -040037/**
38 * \brief Provides access to NFD channel dataset.
39 * \sa https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Channel-Dataset
Junxiao Shi38f4ce92016-08-04 10:01:52 +000040 */
Davide Pesavento40641272023-03-16 13:31:12 -040041class ChannelModule : public Module, boost::noncopyable
Junxiao Shi38f4ce92016-08-04 10:01:52 +000042{
43public:
Davide Pesavento87fc0f82018-04-11 23:43:51 -040044 void
Davide Pesavento63b3ae82023-03-24 23:53:24 -040045 fetchStatus(ndn::nfd::Controller& controller,
Davide Pesavento87fc0f82018-04-11 23:43:51 -040046 const std::function<void()>& onSuccess,
Davide Pesavento63b3ae82023-03-24 23:53:24 -040047 const ndn::nfd::DatasetFailureCallback& onFailure,
Junxiao Shi38f4ce92016-08-04 10:01:52 +000048 const CommandOptions& options) override;
49
Davide Pesavento87fc0f82018-04-11 23:43:51 -040050 void
Junxiao Shi38f4ce92016-08-04 10:01:52 +000051 formatStatusXml(std::ostream& os) const override;
52
Davide Pesaventoaa9e3b22022-10-21 17:00:07 -040053 /** \brief Format a single status item as XML.
Junxiao Shi38f4ce92016-08-04 10:01:52 +000054 * \param os output stream
55 * \param item status item
56 */
57 void
58 formatItemXml(std::ostream& os, const ChannelStatus& item) const;
59
Davide Pesavento87fc0f82018-04-11 23:43:51 -040060 void
Junxiao Shi38f4ce92016-08-04 10:01:52 +000061 formatStatusText(std::ostream& os) const override;
62
Davide Pesaventoaa9e3b22022-10-21 17:00:07 -040063 /** \brief Format a single status item as text.
Junxiao Shi38f4ce92016-08-04 10:01:52 +000064 * \param os output stream
65 * \param item status item
66 */
67 void
68 formatItemText(std::ostream& os, const ChannelStatus& item) const;
69
70private:
71 std::vector<ChannelStatus> m_status;
72};
73
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040074} // namespace nfd::tools::nfdc
Junxiao Shi38f4ce92016-08-04 10:01:52 +000075
Junxiao Shi331ade72016-08-19 14:07:19 +000076#endif // NFD_TOOLS_NFDC_CHANNEL_MODULE_HPP