1 files changed, 193 insertions, 0 deletions
diff --git a/libtransport/src/hicn/transport/protocols/indexing_manager.h b/libtransport/src/hicn/transport/protocols/indexing_manager.h
new file mode 100644
index 000000000..888b17d9d
--- /dev/null
+++ b/libtransport/src/hicn/transport/protocols/indexing_manager.h
@@ -0,0 +1,193 @@
+/*
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <hicn/transport/errors/runtime_exception.h>
+#include <hicn/transport/errors/unexpected_manifest_exception.h>
+#include <hicn/transport/interfaces/socket_consumer.h>
+#include <hicn/transport/protocols/verification_manager.h>
+#include <hicn/transport/utils/literals.h>
+
+#include <deque>
+
+namespace transport {
+
+namespace protocol {
+
+class IndexManager {
+ public:
+  static constexpr uint32_t invalid_index = ~0;
+
+  /**
+   *
+   */
+  virtual ~IndexManager() = default;
+  /**
+   * Retrieve from the manifest the next suffix to retrieve.
+   */
+  virtual uint32_t getNextSuffix() = 0;
+
+  /**
+   * Retrive the next segment to be reassembled.
+   */
+  virtual uint32_t getNextReassemblySegment() = 0;
+
+  virtual bool isFinalSuffixDiscovered() = 0;
+
+  virtual uint32_t getFinalSuffix() = 0;
+
+  virtual void reset() = 0;
+};
+
+class IndexVerificationManager : public IndexManager {
+ public:
+  /**
+   *
+   */
+  virtual ~IndexVerificationManager() = default;
+
+  /**
+   * The ownership of the ContentObjectManifest is moved
+   * from the caller to the VerificationManager
+   */
+  virtual bool onManifest(core::ContentObject::Ptr &&content_object) = 0;
+
+  /**
+   * The content object must just be verified; the ownership is still of the
+   * caller.
+   */
+  virtual bool onContentObject(const core::ContentObject &content_object) = 0;
+};
+
+class ZeroIndexManager : public IndexVerificationManager {
+ public:
+  ZeroIndexManager() : reset_(true) {}
+
+  TRANSPORT_ALWAYS_INLINE virtual void reset() override { reset_ = true; }
+
+  /**
+   * Retrieve from the manifest the next suffix to retrieve.
+   */
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextSuffix() override {
+    uint32_t ret = reset_ ? 0 : IndexManager::invalid_index;
+    reset_ = false;
+    return ret;
+  }
+
+  /**
+   * Retrive the next segment to be reassembled.
+   */
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextReassemblySegment() override {
+    return IndexManager::invalid_index;
+  }
+
+  TRANSPORT_ALWAYS_INLINE virtual bool isFinalSuffixDiscovered() override {
+    return false;
+  }
+
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getFinalSuffix() override {
+    return IndexManager::invalid_index;
+  }
+
+  TRANSPORT_ALWAYS_INLINE bool onManifest(
+      core::ContentObject::Ptr &&content_object) override {
+    throw errors::UnexpectedManifestException();
+  }
+
+  TRANSPORT_ALWAYS_INLINE bool onContentObject(
+      const core::ContentObject &content_object) override {
+    throw errors::RuntimeException(
+        "Called onContentObject on a ZeroIndexManager, which is not able to "
+        "process packets.");
+  }
+
+ private:
+  bool reset_;
+};
+
+class IncrementalIndexManager : public IndexVerificationManager {
+ public:
+  IncrementalIndexManager(interface::ConsumerSocket *icn_socket)
+      : socket_(icn_socket),
+        final_suffix_(std::numeric_limits<uint64_t>::max()),
+        next_download_suffix_(0),
+        next_reassembly_suffix_(0),
+        verification_manager_(
+            std::make_unique<SignatureVerificationManager>(icn_socket)) {}
+
+  /**
+   *
+   */
+  virtual ~IncrementalIndexManager() {}
+
+  TRANSPORT_ALWAYS_INLINE virtual void reset() override {
+    final_suffix_ = std::numeric_limits<uint64_t>::max();
+    next_download_suffix_ = 0;
+    next_reassembly_suffix_ = 0;
+  }
+
+  /**
+   * Retrieve from the manifest the next suffix to retrieve.
+   */
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextSuffix() override {
+    return next_download_suffix_ <= final_suffix_ ? next_download_suffix_++
+                                                  : IndexManager::invalid_index;
+  }
+
+  /**
+   * Retrive the next segment to be reassembled.
+   */
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getNextReassemblySegment() override {
+    return next_reassembly_suffix_ <= final_suffix_
+               ? next_reassembly_suffix_++
+               : IndexManager::invalid_index;
+  }
+
+  TRANSPORT_ALWAYS_INLINE virtual bool isFinalSuffixDiscovered() override {
+    return final_suffix_ != std::numeric_limits<uint64_t>::max();
+  }
+
+  TRANSPORT_ALWAYS_INLINE virtual uint32_t getFinalSuffix() override {
+    return final_suffix_;
+  }
+
+  TRANSPORT_ALWAYS_INLINE bool onManifest(
+      core::ContentObject::Ptr &&content_object) override {
+    throw errors::UnexpectedManifestException();
+  }
+
+  TRANSPORT_ALWAYS_INLINE bool onContentObject(
+      const core::ContentObject &content_object) override {
+    auto ret = verification_manager_->onPacketToVerify(content_object);
+
+    if (TRANSPORT_EXPECT_FALSE(content_object.testRst())) {
+      final_suffix_ = content_object.getName().getSuffix();
+    }
+
+    return ret;
+  }
+
+ protected:
+  interface::ConsumerSocket *socket_;
+  uint64_t final_suffix_;
+  uint64_t next_download_suffix_;
+  uint64_t next_reassembly_suffix_;
+  std::unique_ptr<VerificationManager> verification_manager_;
+};
+
+}  // end namespace protocol
+
+}  // end namespace transport