fw: UnsolicitedDataPolicy
The decision of whether to cache or drop an unsolicited Data is moved from
Data unsolicited pipeline to UnsolicitedDataPolicy.
refs #2181
Change-Id: Iba3e72c2214e0ac5f6f305c2c1c0ed182b008e85
diff --git a/daemon/fw/unsolicited-data-policy.hpp b/daemon/fw/unsolicited-data-policy.hpp
new file mode 100644
index 0000000..54112ec
--- /dev/null
+++ b/daemon/fw/unsolicited-data-policy.hpp
@@ -0,0 +1,71 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2014-2016, Regents of the University of California,
+ * Arizona Board of Regents,
+ * Colorado State University,
+ * University Pierre & Marie Curie, Sorbonne University,
+ * Washington University in St. Louis,
+ * Beijing Institute of Technology,
+ * The University of Memphis.
+ *
+ * This file is part of NFD (Named Data Networking Forwarding Daemon).
+ * See AUTHORS.md for complete list of NFD authors and contributors.
+ *
+ * NFD is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU General Public License as published by the Free Software Foundation,
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef NFD_DAEMON_FW_UNSOLICITED_DATA_POLICY_HPP
+#define NFD_DAEMON_FW_UNSOLICITED_DATA_POLICY_HPP
+
+#include "face/face.hpp"
+
+namespace nfd {
+namespace fw {
+
+/** \brief a decision made by UnsolicitedDataPolicy
+ */
+enum class UnsolicitedDataDecision {
+ DROP, ///< the Data should be dropped
+ CACHE ///< the Data should be cached in the ContentStore
+};
+
+std::ostream&
+operator<<(std::ostream& os, UnsolicitedDataDecision d);
+
+/** \brief determines how to process an unsolicited Data
+ *
+ * An incoming Data is unsolicited if it does not match any PIT entry.
+ * This class assists forwarding pipelines to decide whether to drop an unsolicited Data
+ * or admit it into the ContentStore.
+ */
+class UnsolicitedDataPolicy : noncopyable
+{
+public:
+ virtual ~UnsolicitedDataPolicy() = default;
+
+ virtual UnsolicitedDataDecision
+ decide(const Face& inFace, const Data& data) const = 0;
+};
+
+/** \brief admits unsolicited Data from local faces
+ */
+class AdmitLocalUnsolicitedDataPolicy : public UnsolicitedDataPolicy
+{
+public:
+ virtual UnsolicitedDataDecision
+ decide(const Face& inFace, const Data& data) const final;
+};
+
+} // namespace fw
+} // namespace nfd
+
+#endif // NFD_DAEMON_FW_UNSOLICITED_DATA_POLICY_HPP