NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
propagated-entry.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
26 #ifndef NFD_RIB_PROPAGATED_ENTRY_HPP
27 #define NFD_RIB_PROPAGATED_ENTRY_HPP
28 
29 #include "core/scheduler.hpp"
30 
31 namespace nfd {
32 namespace rib {
33 
34 enum class PropagationStatus {
36  NEW,
38  PROPAGATING,
40  PROPAGATED,
42  PROPAGATE_FAIL
43 };
44 
45 void
46 operator<<(std::ostream& out, PropagationStatus status);
47 
56 class PropagatedEntry
57 {
58 public:
59  PropagatedEntry();
60 
64  PropagatedEntry(const PropagatedEntry& other);
65 
66  PropagatedEntry&
67  operator=(const PropagatedEntry& other) = delete;
68 
72  PropagatedEntry&
73  setSigningIdentity(const Name& identity);
74 
80  const Name&
81  getSigningIdentity() const;
82 
88  void
89  startPropagation();
90 
97  void
98  succeed(const scheduler::EventId& event);
99 
106  void
107  fail(const scheduler::EventId& event);
108 
114  void
115  initialize();
116 
122  bool
123  isNew() const;
124 
130  bool
131  isPropagating() const;
132 
138  bool
139  isPropagated() const;
140 
146  bool
147  isPropagateFail() const;
148 
149 PUBLIC_WITH_TESTS_ELSE_PRIVATE:
150  Name m_signingIdentity;
151  scheduler::ScopedEventId m_rePropagateEvent;
152  PropagationStatus m_propagationStatus;
153 };
154 
155 } // namespace rib
156 } // namespace nfd
157 
158 #endif // NFD_RIB_PROPAGATED_ENTRY_HPP
PUBLIC_WITH_TESTS_ELSE_PRIVATE
#define PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:40
nfd::rib::PropagatedEntry::fail
void fail(const scheduler::EventId &event)
switch the propagation status to PROPAGATE_FAIL, and then set the rePropagateEvent to event for retry...
Definition: propagated-entry.cpp:93
nfd::scheduler::EventId
Opaque handle for a scheduled event.
nfd::rib::operator<<
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
Definition: fib-update.hpp:74
nfd::rib::PropagatedEntry::setSigningIdentity
PropagatedEntry & setSigningIdentity(const Name &identity)
set the signing identity
Definition: propagated-entry.cpp:67
nfd::rib::PropagatedEntry::operator=
PropagatedEntry & operator=(const PropagatedEntry &other)=delete
nfd::rib::PropagatedEntry::getSigningIdentity
const Name & getSigningIdentity() const
get the signing identity
Definition: propagated-entry.cpp:74
nfd::rib::PropagatedEntry::initialize
void initialize()
cancel the events of re-sending propagation commands.
Definition: propagated-entry.cpp:100
nfd::rib::PropagatedEntry::isPropagateFail
bool isPropagateFail() const
check whether this entry has failed in propagating.
Definition: propagated-entry.cpp:125
nfd::rib::PropagatedEntry::isPropagating
bool isPropagating() const
check whether this entry is being propagated.
Definition: propagated-entry.cpp:113
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::scheduler::ScopedEventId
Cancels an event automatically upon destruction.
Definition: scheduler.hpp:60
nfd::rib::PropagatedEntry::isPropagated
bool isPropagated() const
check whether this entry has been successfully propagated.
Definition: propagated-entry.cpp:119
ndn::Name
Represents an absolute name.
Definition: name.hpp:42
nfd::rib::PropagatedEntry::isNew
bool isNew() const
check whether this entry is a new entry.
Definition: propagated-entry.cpp:107
nfd::rib::PropagatedEntry::succeed
void succeed(const scheduler::EventId &event)
switch the propagation status to PROPAGATED, and set the rePropagateEvent to event for refresh...
Definition: propagated-entry.cpp:86
nfd::rib::PropagationStatus::PROPAGATED
has been propagated successfully
nfd::rib::PropagatedEntry
represents an entry for prefix propagation.
Definition: propagated-entry.hpp:56
nfd::rib::PropagatedEntry::startPropagation
void startPropagation()
switch the propagation status to PROPAGATING.
Definition: propagated-entry.cpp:80