propagated-entry.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NFD_RIB_PROPAGATED_ENTRY_HPP
#define NFD_RIB_PROPAGATED_ENTRY_HPP

#include "core/scheduler.hpp"

namespace nfd {
namespace rib {

enum class PropagationStatus {
  NEW,
  PROPAGATING,
  PROPAGATED,
  PROPAGATE_FAIL
};

void
operator<<(std::ostream& out, PropagationStatus status);

class PropagatedEntry
{
public:
  PropagatedEntry();

  PropagatedEntry(const PropagatedEntry& other);

  PropagatedEntry&
  operator=(const PropagatedEntry& other) = delete;

  PropagatedEntry&
  setSigningIdentity(const Name& identity);

  const Name&
  getSigningIdentity() const;

  void
  startPropagation();

  void
  succeed(const scheduler::EventId& event);

  void
  fail(const scheduler::EventId& event);

  void
  initialize();

  bool
  isNew() const;

  bool
  isPropagating() const;

  bool
  isPropagated() const;

  bool
  isPropagateFail() const;

PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  Name m_signingIdentity;
  scheduler::ScopedEventId m_rePropagateEvent;
  PropagationStatus m_propagationStatus;
};

} // namespace rib
} // namespace nfd

#endif // NFD_RIB_PROPAGATED_ENTRY_HPP