blob: 422de2b4ee60a71d981b6c7c35a516ac7322b174 [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Alexander Afanasyev4671bf72014-05-19 09:01:37 -04002/**
Alexander Afanasyev74633892015-02-08 18:08:46 -08003 * Copyright (c) 2013-2015 Regents of the University of California.
Alexander Afanasyev4671bf72014-05-19 09:01:37 -04004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyev4671bf72014-05-19 09:01:37 -04006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040020 */
21
22#ifndef NDN_MANAGEMENT_NFD_CHANNEL_STATUS_HPP
23#define NDN_MANAGEMENT_NFD_CHANNEL_STATUS_HPP
24
Junxiao Shi65f1a712014-11-20 14:59:36 -070025#include "../encoding/block.hpp"
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040026
27namespace ndn {
28namespace nfd {
29
30/**
31 * @ingroup management
32 * @brief represents NFD Channel Status dataset
33 * @sa http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Channel-Dataset
34 */
35class ChannelStatus
36{
37public:
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060038 class Error : public tlv::Error
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040039 {
40 public:
41 explicit
42 Error(const std::string& what)
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060043 : tlv::Error(what)
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040044 {
45 }
46 };
47
Junxiao Shi65f1a712014-11-20 14:59:36 -070048 ChannelStatus();
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040049
50 explicit
Junxiao Shi65f1a712014-11-20 14:59:36 -070051 ChannelStatus(const Block& payload);
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040052
Alexander Afanasyev74633892015-02-08 18:08:46 -080053 template<encoding::Tag TAG>
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040054 size_t
Alexander Afanasyev74633892015-02-08 18:08:46 -080055 wireEncode(EncodingImpl<TAG>& encoder) const;
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040056
57 const Block&
58 wireEncode() const;
59
60 void
61 wireDecode(const Block& wire);
62
63public: // getters & setters
64 const std::string&
65 getLocalUri() const
66 {
67 return m_localUri;
68 }
69
70 ChannelStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -070071 setLocalUri(const std::string localUri);
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040072
73private:
74 std::string m_localUri;
75
76 mutable Block m_wire;
77};
78
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040079} // namespace nfd
80} // namespace ndn
81
82#endif // NDN_MANAGEMENT_NFD_CHANNEL_STATUS_HPP