util: Implement helper class to fetch multi-segmented data
Change-Id: I03137869a21a194fa88ae7cae03ef402294771db
Refs: #1879
diff --git a/src/util/segment-fetcher.cpp b/src/util/segment-fetcher.cpp
new file mode 100644
index 0000000..e7703c5
--- /dev/null
+++ b/src/util/segment-fetcher.cpp
@@ -0,0 +1,119 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2014 Regents of the University of California.
+ *
+ * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ *
+ * ndn-cxx library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-cxx library 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 Lesser General Public License for more details.
+ *
+ * You should have received copies of the GNU General Public License and GNU Lesser
+ * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ */
+
+#include "segment-fetcher.hpp"
+
+#include "../encoding/buffer-stream.hpp"
+
+namespace ndn {
+namespace util {
+
+SegmentFetcher::SegmentFetcher(Face& face,
+ const VerifySegment& verifySegment,
+ const CompleteCallback& completeCallback,
+ const ErrorCallback& errorCallback)
+ : m_face(face)
+ , m_verifySegment(verifySegment)
+ , m_completeCallback(completeCallback)
+ , m_errorCallback(errorCallback)
+ , m_buffer(make_shared<OBufferStream>())
+{
+}
+
+void
+SegmentFetcher::fetch(Face& face,
+ const Interest& baseInterest,
+ const VerifySegment& verifySegment,
+ const CompleteCallback& completeCallback,
+ const ErrorCallback& errorCallback)
+{
+ shared_ptr<SegmentFetcher> fetcher =
+ shared_ptr<SegmentFetcher>(new SegmentFetcher(face, verifySegment,
+ completeCallback, errorCallback));
+
+ fetcher->fetchFirstSegment(baseInterest, fetcher);
+}
+
+void
+SegmentFetcher::fetchFirstSegment(const Interest& baseInterest,
+ const shared_ptr<SegmentFetcher>& self)
+{
+ Interest interest(baseInterest);
+ interest.setChildSelector(1);
+ interest.setMustBeFresh(true);
+
+ m_face.expressInterest(interest,
+ bind(&SegmentFetcher::onSegmentReceived, this, _1, _2, true, self),
+ bind(m_errorCallback, INTEREST_TIMEOUT, "Timeout"));
+}
+
+void
+SegmentFetcher::fetchNextSegment(const Interest& origInterest, const Name& dataName,
+ uint64_t segmentNo,
+ const shared_ptr<SegmentFetcher>& self)
+{
+ Interest interest(origInterest); // to preserve any special selectors
+ interest.refreshNonce();
+ interest.setChildSelector(0);
+ interest.setMustBeFresh(false);
+ interest.setName(dataName.getPrefix(-1).appendSegment(segmentNo));
+ m_face.expressInterest(interest,
+ bind(&SegmentFetcher::onSegmentReceived, this, _1, _2, false, self),
+ bind(m_errorCallback, INTEREST_TIMEOUT, "Timeout"));
+}
+
+void
+SegmentFetcher::onSegmentReceived(const Interest& origInterest,
+ const Data& data, bool isSegmentZeroExpected,
+ const shared_ptr<SegmentFetcher>& self)
+{
+ if (!m_verifySegment(data)) {
+ return m_errorCallback(SEGMENT_VERIFICATION_FAIL, "Segment validation fail");
+ }
+
+ try {
+ uint64_t currentSegment = data.getName().get(-1).toSegment();
+
+ if (isSegmentZeroExpected && currentSegment != 0) {
+ fetchNextSegment(origInterest, data.getName(), 0, self);
+ }
+ else {
+ m_buffer->write(reinterpret_cast<const char*>(data.getContent().value()),
+ data.getContent().value_size());
+
+ const name::Component& finalBlockId = data.getMetaInfo().getFinalBlockId();
+ if (finalBlockId.empty() ||
+ finalBlockId.toSegment() > currentSegment)
+ {
+ fetchNextSegment(origInterest, data.getName(), currentSegment + 1, self);
+ }
+ else {
+ return m_completeCallback(m_buffer->buf());
+ }
+ }
+ }
+ catch (const tlv::Error& e) {
+ m_errorCallback(DATA_HAS_NO_SEGMENT, std::string("Error while decoding segment: ") + e.what());
+ }
+}
+
+} // util
+} // ndn
diff --git a/src/util/segment-fetcher.hpp b/src/util/segment-fetcher.hpp
new file mode 100644
index 0000000..f2fbe38
--- /dev/null
+++ b/src/util/segment-fetcher.hpp
@@ -0,0 +1,182 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2014 Regents of the University of California.
+ *
+ * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ *
+ * ndn-cxx library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-cxx library 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 Lesser General Public License for more details.
+ *
+ * You should have received copies of the GNU General Public License and GNU Lesser
+ * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ */
+
+#ifndef NDN_UTIL_SEGMENT_FETCHER_HPP
+#define NDN_UTIL_SEGMENT_FETCHER_HPP
+
+#include "../common.hpp"
+#include "../face.hpp"
+
+namespace ndn {
+
+class OBufferStream;
+
+namespace util {
+
+/**
+ * @brief Functor to skip validation of individual packets by SegmentFetcher
+ */
+class DontVerifySegment
+{
+public:
+ bool
+ operator()(const Data& data) const
+ {
+ return true;
+ }
+};
+
+/**
+ * @brief Utility class to fetch latest version of the segmented data
+ *
+ * SegmentFetcher assumes that the data is named /<prefix>/<version>/<segment>,
+ * where:
+ * - <prefix> is the specified prefix,
+ * - <version> is an unknown version that needs to be discovered, and
+ * - <segment> is a segment number (number of segments is unknown and is controlled
+ * by `FinalBlockId` field in at least the last Data packet
+ *
+ * The following logic is implemented in SegmentFetcher:
+ *
+ * 1. Express first interest to discover version:
+ *
+ * >> Interest: /<prefix>?ChildSelector=1&MustBeFresh=yes
+ *
+ * 2. Infer the latest version of Data: <version> = Data.getName().get(-2)
+ *
+ * 3. If segment number in the retrieved packet == 0, go to step 5.
+ *
+ * 4. Send Interest for segment 0:
+ *
+ * >> Interest: /<prefix>/<version>/<segment=0>
+ *
+ * 5. Keep sending Interests for the next segment while the retrieved Data does not have
+ * FinalBlockId or FinalBlockId != Data.getName().get(-1).
+ *
+ * >> Interest: /<prefix>/<version>/<segment=(N+1))>
+ *
+ * 6. Fire onCompletion callback with memory block that combines content part from all
+ * segmented objects.
+ *
+ * If an error occurs during the fetching process, an error callback is fired
+ * with a proper error code. The following errors are possible:
+ *
+ * - `INTEREST_TIMEOUT`: if any of the Interests times out
+ * - `DATA_HAS_NO_SEGMENT`: if any of the retrieved Data packets don't have segment
+ * as a last component of the name (not counting implicit digest)
+ * - `SEGMENT_VERIFICATION_FAIL`: if any retrieved segment fails user-provided validation
+ *
+ * In order to validate individual segments, an VerifySegment callback needs to be specified.
+ * If the callback returns false, fetching process is aborted with SEGMENT_VERIFICATION_FAIL.
+ * If data validation is not required, provided DontVerifySegment() functor can be used.
+ *
+ * Examples:
+ *
+ * void
+ * onComplete(const ConstBufferPtr& data)
+ * {
+ * ...
+ * }
+ *
+ * void
+ * onError(uint32_t errorCode, const std::string& errorMsg)
+ * {
+ * ...
+ * }
+ *
+ * ...
+ * SegmentFetcher::fetch(face, Interest("/data/prefix", time::seconds(1000)),
+ * DontVerifySegment(),
+ * bind(&onComplete, this, _1),
+ * bind(&onError, this, _1, _2));
+ *
+ */
+class SegmentFetcher : noncopyable
+{
+public:
+ typedef function<void (const ConstBufferPtr& data)> CompleteCallback;
+ typedef function<bool (const Data& data)> VerifySegment;
+ typedef function<void (uint32_t code, const std::string& msg)> ErrorCallback;
+
+ /**
+ * @brief Error codes that can be passed to ErrorCallback
+ */
+ enum ErrorCode {
+ INTEREST_TIMEOUT = 1,
+ DATA_HAS_NO_SEGMENT = 2,
+ SEGMENT_VERIFICATION_FAIL = 3
+ };
+
+ /**
+ * @brief Initiate segment fetching
+ *
+ * @param face Reference to the Face that should be used to fetch data
+ * @param baseInterest An Interest for the initial segment of requested data.
+ * This interest may include custom InterestLifetime and selectors that
+ * will propagate to all subsequent Interests. The only exception is that
+ * the initial Interest will be forced to include "ChildSelector=1" and
+ * "MustBeFresh=true" selectors, which will be turned off in subsequent
+ * Interests.
+ * @param verifySegment Functor to be called when Data segment is received. If
+ * functor return false, fetching will be aborted with
+ * SEGMENT_VERIFICATION_FAIL error
+ * @param completeCallback Callback to be fired when all segments are fetched
+ * @param errorCallback Callback to be fired when an error occurs (@see Errors)
+ */
+ static
+ void
+ fetch(Face& face,
+ const Interest& baseInterest,
+ const VerifySegment& verifySegment,
+ const CompleteCallback& completeCallback,
+ const ErrorCallback& errorCallback);
+
+private:
+ SegmentFetcher(Face& face,
+ const VerifySegment& verifySegment,
+ const CompleteCallback& completeCallback,
+ const ErrorCallback& errorCallback);
+
+ void
+ fetchFirstSegment(const Interest& baseInterest, const shared_ptr<SegmentFetcher>& self);
+
+ void
+ fetchNextSegment(const Interest& origInterest, const Name& dataName, uint64_t segmentNo,
+ const shared_ptr<SegmentFetcher>& self);
+
+ void
+ onSegmentReceived(const Interest& origInterest,
+ const Data& data, bool isSegmentZeroExpected,
+ const shared_ptr<SegmentFetcher>& self);
+
+private:
+ Face& m_face;
+ VerifySegment m_verifySegment;
+ CompleteCallback m_completeCallback;
+ ErrorCallback m_errorCallback;
+
+ shared_ptr<OBufferStream> m_buffer;
+};
+
+} // util
+} // ndn
+
+#endif // NDN_UTIL_SEGMENT_FETCHER_HPP
diff --git a/tests/unit-tests/util/segment-fetcher.cpp b/tests/unit-tests/util/segment-fetcher.cpp
new file mode 100644
index 0000000..f5d274d
--- /dev/null
+++ b/tests/unit-tests/util/segment-fetcher.cpp
@@ -0,0 +1,297 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2013-2014 Regents of the University of California.
+ *
+ * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
+ *
+ * ndn-cxx library is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-cxx library 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 Lesser General Public License for more details.
+ *
+ * You should have received copies of the GNU General Public License and GNU Lesser
+ * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ */
+
+#include "util/segment-fetcher.hpp"
+
+#include "boost-test.hpp"
+#include "../dummy-client-face.hpp"
+#include "security/key-chain.hpp"
+
+namespace ndn {
+namespace util {
+namespace tests {
+
+BOOST_AUTO_TEST_SUITE(UtilSegmentFetcher)
+
+class Fixture
+{
+public:
+ Fixture()
+ : face(::ndn::tests::makeDummyClientFace())
+ , nErrors(0)
+ , nDatas(0)
+ , dataSize(0)
+ {
+ }
+
+ shared_ptr<Data>
+ makeData(const Name& baseName, uint64_t segment, bool isFinal)
+ {
+ const uint8_t buffer[] = "Hello, world!";
+
+ shared_ptr<Data> data = make_shared<Data>(Name(baseName).appendSegment(segment));
+ data->setContent(buffer, sizeof(buffer));
+
+ if (isFinal)
+ data->setFinalBlockId(data->getName()[-1]);
+ keyChain.sign(*data);
+
+ return data;
+ }
+
+ void
+ onError(uint32_t errorCode)
+ {
+ ++nErrors;
+ lastError = errorCode;
+ }
+
+ void
+ onData(const ConstBufferPtr& data)
+ {
+ ++nDatas;
+ dataSize = data->size();
+ }
+
+
+public:
+ shared_ptr<ndn::tests::DummyClientFace> face;
+ KeyChain keyChain;
+
+ uint32_t nErrors;
+ uint32_t lastError;
+ uint32_t nDatas;
+ size_t dataSize;
+};
+
+BOOST_FIXTURE_TEST_CASE(Timeout, Fixture)
+{
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::milliseconds(100)),
+ DontVerifySegment(),
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+ face->processEvents(time::seconds(1));
+
+ BOOST_CHECK_EQUAL(nErrors, 1);
+ BOOST_CHECK_EQUAL(lastError, static_cast<uint32_t>(SegmentFetcher::INTEREST_TIMEOUT));
+ BOOST_CHECK_EQUAL(nDatas, 0);
+ BOOST_REQUIRE_EQUAL(face->m_sentInterests.size(), 1);
+ BOOST_CHECK_EQUAL(face->m_sentDatas.size(), 0);
+
+ const Interest& interest = face->m_sentInterests[0];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), true);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 1);
+}
+
+
+BOOST_FIXTURE_TEST_CASE(Basic, Fixture)
+{
+
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::seconds(1000)),
+ DontVerifySegment(),
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 0, true));
+ face->processEvents(time::milliseconds(-100));
+
+ BOOST_CHECK_EQUAL(nErrors, 0);
+ BOOST_CHECK_EQUAL(nDatas, 1);
+
+ BOOST_CHECK_EQUAL(dataSize, 14);
+
+ BOOST_REQUIRE_EQUAL(face->m_sentInterests.size(), 1);
+ BOOST_CHECK_EQUAL(face->m_sentDatas.size(), 0);
+
+ const Interest& interest = face->m_sentInterests[0];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), true);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 1);
+}
+
+BOOST_FIXTURE_TEST_CASE(NoSegmentInData, Fixture)
+{
+
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::seconds(1000)),
+ DontVerifySegment(),
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+ face->processEvents(time::milliseconds(-100));
+
+ const uint8_t buffer[] = "Hello, world!";
+
+ shared_ptr<Data> data = make_shared<Data>("/hello/world/version0/no-segment");
+ data->setContent(buffer, sizeof(buffer));
+ keyChain.sign(*data);
+
+ face->receive(*data);
+ face->processEvents(time::milliseconds(-100));
+
+ BOOST_CHECK_EQUAL(nErrors, 1);
+ BOOST_CHECK_EQUAL(lastError, static_cast<uint32_t>(SegmentFetcher::DATA_HAS_NO_SEGMENT));
+ BOOST_CHECK_EQUAL(nDatas, 0);
+}
+
+bool
+failValidation(const Data& data)
+{
+ return false;
+}
+
+BOOST_FIXTURE_TEST_CASE(SegmentValidationFailure, Fixture)
+{
+
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::seconds(1000)),
+ &failValidation,
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 0, true));
+ face->processEvents(time::milliseconds(-100));
+
+ BOOST_CHECK_EQUAL(nErrors, 1);
+ BOOST_CHECK_EQUAL(lastError, static_cast<uint32_t>(SegmentFetcher::SEGMENT_VERIFICATION_FAIL));
+ BOOST_CHECK_EQUAL(nDatas, 0);
+}
+
+
+BOOST_FIXTURE_TEST_CASE(Triple, Fixture)
+{
+ KeyChain keyChain;
+
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::seconds(1000)),
+ DontVerifySegment(),
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 0, false));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 1, false));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 2, true));
+
+ face->processEvents(time::milliseconds(-100));
+
+ BOOST_CHECK_EQUAL(nErrors, 0);
+ BOOST_CHECK_EQUAL(nDatas, 1);
+
+ BOOST_CHECK_EQUAL(dataSize, 42);
+
+ BOOST_REQUIRE_EQUAL(face->m_sentInterests.size(), 3);
+ BOOST_CHECK_EQUAL(face->m_sentDatas.size(), 0);
+
+ {
+ const Interest& interest = face->m_sentInterests[0];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), true);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 1);
+ }
+
+ {
+ const Interest& interest = face->m_sentInterests[1];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world/version0/%00%01");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), false);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 0);
+ }
+
+ {
+ const Interest& interest = face->m_sentInterests[2];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world/version0/%00%02");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), false);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 0);
+ }
+}
+
+BOOST_FIXTURE_TEST_CASE(TripleWithInitialSegmentFetching, Fixture)
+{
+ KeyChain keyChain;
+
+ SegmentFetcher::fetch(*face, Interest("/hello/world", time::seconds(1000)),
+ DontVerifySegment(),
+ bind(&Fixture::onData, this, _1),
+ bind(&Fixture::onError, this, _1));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 1, false));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 0, false));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 1, false));
+
+ face->processEvents(time::milliseconds(-100));
+ face->receive(*makeData("/hello/world/version0", 2, true));
+
+ face->processEvents(time::milliseconds(-100));
+
+ BOOST_CHECK_EQUAL(nErrors, 0);
+ BOOST_CHECK_EQUAL(nDatas, 1);
+
+ BOOST_CHECK_EQUAL(dataSize, 42);
+
+ BOOST_REQUIRE_EQUAL(face->m_sentInterests.size(), 4);
+ BOOST_CHECK_EQUAL(face->m_sentDatas.size(), 0);
+
+ {
+ const Interest& interest = face->m_sentInterests[0];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), true);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 1);
+ }
+
+ {
+ const Interest& interest = face->m_sentInterests[1];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world/version0/%00%00");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), false);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 0);
+ }
+
+ {
+ const Interest& interest = face->m_sentInterests[2];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world/version0/%00%01");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), false);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 0);
+ }
+
+ {
+ const Interest& interest = face->m_sentInterests[3];
+ BOOST_CHECK_EQUAL(interest.getName(), "/hello/world/version0/%00%02");
+ BOOST_CHECK_EQUAL(interest.getMustBeFresh(), false);
+ BOOST_CHECK_EQUAL(interest.getChildSelector(), 0);
+ }
+}
+
+
+BOOST_AUTO_TEST_SUITE_END()
+
+} // namespace tests
+} // namespace util
+} // namespace ndn