| /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| /** |
| * Copyright (C) 2014 Named Data Networking Project |
| * See COPYING for copyright and distribution information. |
| */ |
| |
| #ifndef NFD_FW_FORWARDER_HPP |
| #define NFD_FW_FORWARDER_HPP |
| |
| #include "common.hpp" |
| #include "core/scheduler.hpp" |
| #include "face-table.hpp" |
| #include "table/fib.hpp" |
| #include "table/pit.hpp" |
| #include "table/cs.hpp" |
| #include "table/measurements.hpp" |
| #include "table/strategy-choice.hpp" |
| |
| namespace nfd { |
| |
| namespace fw { |
| class Strategy; |
| } // namespace fw |
| |
| /** \brief main class of NFD |
| * |
| * Forwarder owns all faces and tables, and implements forwarding pipelines. |
| */ |
| class Forwarder |
| { |
| public: |
| Forwarder(); |
| |
| public: // faces |
| FaceTable& |
| getFaceTable(); |
| |
| /** \brief get existing Face |
| * |
| * shortcut to .getFaceTable().get(face) |
| */ |
| shared_ptr<Face> |
| getFace(FaceId id) const; |
| |
| /** \brief add new Face |
| * |
| * shortcut to .getFaceTable().add(face) |
| */ |
| void |
| addFace(shared_ptr<Face> face); |
| |
| /** \brief remove existing Face |
| * |
| * shortcut to .getFaceTable().remove(face) |
| */ |
| void |
| removeFace(shared_ptr<Face> face); |
| |
| public: // forwarding entrypoints and tables |
| void |
| onInterest(Face& face, const Interest& interest); |
| |
| void |
| onData(Face& face, const Data& data); |
| |
| Fib& |
| getFib(); |
| |
| Pit& |
| getPit(); |
| |
| Cs& |
| getCs(); |
| |
| Measurements& |
| getMeasurements(); |
| |
| StrategyChoice& |
| getStrategyChoice(); |
| |
| PUBLIC_WITH_TESTS_ELSE_PRIVATE: // pipelines |
| /** \brief incoming Interest pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onIncomingInterest(Face& inFace, const Interest& interest); |
| |
| /** \brief Interest loop pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onInterestLoop(Face& inFace, const Interest& interest, |
| shared_ptr<pit::Entry> pitEntry); |
| |
| /** \brief outgoing Interest pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onOutgoingInterest(shared_ptr<pit::Entry> pitEntry, Face& outFace); |
| |
| /** \brief Interest reject pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onInterestReject(shared_ptr<pit::Entry> pitEntry); |
| |
| /** \brief Interest unsatisfied pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onInterestUnsatisfied(shared_ptr<pit::Entry> pitEntry); |
| |
| /** \brief incoming Data pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onIncomingData(Face& inFace, const Data& data); |
| |
| /** \brief Data unsolicited pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onDataUnsolicited(Face& inFace, const Data& data); |
| |
| /** \brief outgoing Data pipeline |
| */ |
| VIRTUAL_WITH_TESTS void |
| onOutgoingData(const Data& data, Face& outFace); |
| |
| PROTECTED_WITH_TESTS_ELSE_PRIVATE: |
| VIRTUAL_WITH_TESTS void |
| setUnsatisfyTimer(shared_ptr<pit::Entry> pitEntry); |
| |
| VIRTUAL_WITH_TESTS void |
| setStragglerTimer(shared_ptr<pit::Entry> pitEntry); |
| |
| VIRTUAL_WITH_TESTS void |
| cancelUnsatisfyAndStragglerTimer(shared_ptr<pit::Entry> pitEntry); |
| |
| VIRTUAL_WITH_TESTS void |
| dispatchToStrategy(const Face& inFace, |
| const Interest& interest, |
| shared_ptr<fib::Entry> fibEntry, |
| shared_ptr<pit::Entry> pitEntry); |
| |
| private: |
| FaceTable m_faceTable; |
| |
| // tables |
| NameTree m_nameTree; |
| Fib m_fib; |
| Pit m_pit; |
| Cs m_cs; |
| Measurements m_measurements; |
| StrategyChoice m_strategyChoice; |
| |
| /// the active strategy (only one strategy in mock) |
| shared_ptr<fw::Strategy> m_strategy; |
| |
| static const Name s_localhostName; |
| |
| // allow Strategy (base class) to enter pipelines |
| friend class fw::Strategy; |
| }; |
| |
| inline FaceTable& |
| Forwarder::getFaceTable() |
| { |
| return m_faceTable; |
| } |
| |
| inline shared_ptr<Face> |
| Forwarder::getFace(FaceId id) const |
| { |
| return m_faceTable.get(id); |
| } |
| |
| inline void |
| Forwarder::addFace(shared_ptr<Face> face) |
| { |
| m_faceTable.add(face); |
| } |
| |
| inline void |
| Forwarder::removeFace(shared_ptr<Face> face) |
| { |
| m_faceTable.remove(face); |
| } |
| |
| inline void |
| Forwarder::onInterest(Face& face, const Interest& interest) |
| { |
| this->onIncomingInterest(face, interest); |
| } |
| |
| inline void |
| Forwarder::onData(Face& face, const Data& data) |
| { |
| this->onIncomingData(face, data); |
| } |
| |
| inline Fib& |
| Forwarder::getFib() |
| { |
| return m_fib; |
| } |
| |
| inline Pit& |
| Forwarder::getPit() |
| { |
| return m_pit; |
| } |
| |
| inline Cs& |
| Forwarder::getCs() |
| { |
| return m_cs; |
| } |
| |
| inline Measurements& |
| Forwarder::getMeasurements() |
| { |
| return m_measurements; |
| } |
| |
| inline StrategyChoice& |
| Forwarder::getStrategyChoice() |
| { |
| return m_strategyChoice; |
| } |
| |
| } // namespace nfd |
| |
| #endif // NFD_FW_FORWARDER_HPP |