NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
face-event-notification.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * 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.
20  */
21 
22 #ifndef NDN_MGMT_NFD_FACE_EVENT_NOTIFICATION_HPP
23 #define NDN_MGMT_NFD_FACE_EVENT_NOTIFICATION_HPP
24 
26 
27 namespace ndn {
28 namespace nfd {
29 
35 class FaceEventNotification : public FaceTraits<FaceEventNotification>
36 {
37 public:
39 
40  explicit
41  FaceEventNotification(const Block& block);
42 
45  template<encoding::Tag TAG>
46  size_t
47  wireEncode(EncodingImpl<TAG>& encoder) const;
48 
51  const Block&
52  wireEncode() const;
53 
56  void
57  wireDecode(const Block& wire);
58 
59 public: // getters & setters
61  getKind() const
62  {
63  return m_kind;
64  }
65 
67  setKind(FaceEventKind kind);
68 
69 private:
70  FaceEventKind m_kind;
71 };
72 
74 
75 bool
77 
78 inline bool
80 {
81  return !(a == b);
82 }
83 
84 std::ostream&
85 operator<<(std::ostream& os, const FaceEventNotification& notification);
86 
87 } // namespace nfd
88 } // namespace ndn
89 
90 #endif // NDN_MGMT_NFD_FACE_EVENT_NOTIFICATION_HPP
ndn::nfd::FaceEventNotification::setKind
FaceEventNotification & setKind(FaceEventKind kind)
Definition: face-event-notification.cpp:159
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus)
ndn::nfd::FaceTraits
provides getters and setters for face information fields
Definition: face-traits.hpp:38
ndn::nfd::operator<<
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
Definition: nfd-constants.cpp:36
ndn::nfd::FaceEventNotification::getKind
FaceEventKind getKind() const
Definition: face-event-notification.hpp:61
face-traits.hpp
ndn::nfd::FaceEventNotification
represents a Face status change notification
Definition: face-event-notification.hpp:36
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
ndn::tlv::nfd::FaceEventNotification
@ FaceEventNotification
Definition: tlv-nfd.hpp:74
ndn::encoding::EncodingImpl
Definition: encoding-buffer-fwd.hpp:36
ndn::nfd::FaceEventKind
FaceEventKind
Definition: nfd-constants.hpp:77
ndn::nfd::FaceEventNotification::wireEncode
const Block & wireEncode() const
encode FaceEventNotification
Definition: face-event-notification.cpp:67
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
ndn::nfd::operator!=
bool operator!=(const ChannelStatus &a, const ChannelStatus &b)
Definition: channel-status.hpp:81
ndn::nfd::FaceEventNotification::FaceEventNotification
FaceEventNotification()
Definition: face-event-notification.cpp:34
ndn::nfd::operator==
bool operator==(const ChannelStatus &a, const ChannelStatus &b)
Definition: channel-status.cpp:97
ndn::nfd::FaceEventNotification::wireDecode
void wireDecode(const Block &wire)
decode FaceEventNotification
Definition: face-event-notification.cpp:83
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34