Rename ndncatchunks to ndnget

Change-Id: I260e552746e900a73c2ce773bd91d9b6fa384734

Author: Pesa

Dockerfile

@@ -23,7 +23,7 @@ RUN --mount=rw,target=/src <<EOF
     mkdir -p /deps/debian
     touch /deps/debian/control
     cd /deps
-    for binary in ndnpeek ndnpoke ndncatchunks ndnputchunks ndnping ndnpingserver ndndump ndn-dissect; do
+    for binary in ndnget ndnputchunks ndnpeek ndnpoke ndnping ndnpingserver ndndump ndn-dissect; do
         dpkg-shlibdeps --ignore-missing-info "/usr/bin/${binary}" -O \
             | sed -n 's|^shlibs:Depends=||p' | sed 's| ([^)]*),\?||g' > "${binary}"
     done
@@ -32,10 +32,10 @@ EOF
 
 FROM ghcr.io/named-data/ndn-cxx-runtime:${NDN_CXX_VERSION} AS ndn-tools
 
+COPY --link --from=build /usr/bin/ndnget /usr/bin/
+COPY --link --from=build /usr/bin/ndnputchunks /usr/bin/
 COPY --link --from=build /usr/bin/ndnpeek /usr/bin/
 COPY --link --from=build /usr/bin/ndnpoke /usr/bin/
-COPY --link --from=build /usr/bin/ndncatchunks /usr/bin/
-COPY --link --from=build /usr/bin/ndnputchunks /usr/bin/
 COPY --link --from=build /usr/bin/ndnping /usr/bin/
 COPY --link --from=build /usr/bin/ndnpingserver /usr/bin/
 COPY --link --from=build /usr/bin/ndndump /usr/bin/

tests/chunks/consumer.t.cpp tests/get/consumer.t.cpptests/chunks/consumer.t.cpp renamed to tests/get/consumer.t.cpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -23,9 +23,9 @@
  * @author Andrea Tosatto
  */
 
-#include "tools/chunks/catchunks/consumer.hpp"
-#include "tools/chunks/catchunks/discover-version.hpp"
-#include "tools/chunks/catchunks/pipeline-interests.hpp"
+#include "tools/get/consumer.hpp"
+#include "tools/get/discover-version.hpp"
+#include "tools/get/pipeline-interests.hpp"
 
 #include "tests/test-common.hpp"
 #include "tests/io-fixture.hpp"
@@ -35,12 +35,12 @@
 
 #include <boost/test/tools/output_test_stream.hpp>
 
-namespace ndn::chunks::tests {
+namespace ndn::tests {
 
-using namespace ndn::tests;
+using namespace ndn::get;
 using boost::test_tools::output_test_stream;
 
-BOOST_AUTO_TEST_SUITE(Chunks)
+BOOST_AUTO_TEST_SUITE(Get)
 BOOST_AUTO_TEST_SUITE(TestConsumer)
 
 BOOST_AUTO_TEST_CASE(InOrderData)
@@ -167,6 +167,6 @@ BOOST_FIXTURE_TEST_CASE(RunBasic, IoFixture)
 }
 
 BOOST_AUTO_TEST_SUITE_END() // TestConsumer
-BOOST_AUTO_TEST_SUITE_END() // Chunks
+BOOST_AUTO_TEST_SUITE_END() // Get
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests

tests/chunks/discover-version.t.cpp tests/get/discover-version.t.cpptests/chunks/discover-version.t.cpp renamed to tests/get/discover-version.t.cpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -23,7 +23,7 @@
  * @author Chavoosh Ghasemi
  */
 
-#include "tools/chunks/catchunks/discover-version.hpp"
+#include "tools/get/discover-version.hpp"
 
 #include "tests/test-common.hpp"
 #include "tests/io-fixture.hpp"
@@ -32,9 +32,9 @@
 #include <ndn-cxx/metadata-object.hpp>
 #include <ndn-cxx/util/dummy-client-face.hpp>
 
-namespace ndn::chunks::tests {
+namespace ndn::tests {
 
-using namespace ndn::tests;
+using namespace ndn::get;
 
 class DiscoverVersionFixture : public IoFixture, public KeyChainFixture
 {
@@ -68,7 +68,7 @@ class DiscoverVersionFixture : public IoFixture, public KeyChainFixture
   bool isDiscoveryFinished = false;
 };
 
-BOOST_AUTO_TEST_SUITE(Chunks)
+BOOST_AUTO_TEST_SUITE(Get)
 BOOST_FIXTURE_TEST_SUITE(TestDiscoverVersion, DiscoverVersionFixture)
 
 BOOST_AUTO_TEST_CASE(Disabled)
@@ -211,6 +211,6 @@ BOOST_AUTO_TEST_CASE(SuccessAfterNackAndTimeout)
 }
 
 BOOST_AUTO_TEST_SUITE_END() // TestDiscoverVersion
-BOOST_AUTO_TEST_SUITE_END() // Chunks
+BOOST_AUTO_TEST_SUITE_END() // Get
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests

…sts/chunks/pipeline-interests-aimd.t.cpp tests/get/pipeline-interests-aimd.t.cpptests/chunks/pipeline-interests-aimd.t.cpp renamed to tests/get/pipeline-interests-aimd.t.cpp tests/chunks/pipeline-interests-aimd.t.cpp renamed to tests/get/pipeline-interests-aimd.t.cpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -25,15 +25,13 @@
  * @author Klaus Schneider
  */
 
-#include "tools/chunks/catchunks/pipeline-interests-aimd.hpp"
+#include "tools/get/pipeline-interests-aimd.hpp"
 
 #include "pipeline-interests-fixture.hpp"
 
 #include <cmath>
 
-namespace ndn::chunks::tests {
-
-using namespace ndn::tests;
+namespace ndn::tests {
 
 class PipelineInterestAimdFixture : public PipelineInterestsFixture
 {
@@ -74,7 +72,7 @@ class PipelineInterestAimdFixture : public PipelineInterestsFixture
   static constexpr double MARGIN = 0.001;
 };
 
-BOOST_AUTO_TEST_SUITE(Chunks)
+BOOST_AUTO_TEST_SUITE(Get)
 BOOST_FIXTURE_TEST_SUITE(TestPipelineInterestsAimd, PipelineInterestAimdFixture)
 
 BOOST_AUTO_TEST_CASE(SlowStart)
@@ -640,6 +638,6 @@ BOOST_AUTO_TEST_CASE(StopsWhenFileSizeLessThanChunkSize)
 }
 
 BOOST_AUTO_TEST_SUITE_END() // TestPipelineInterestsAimd
-BOOST_AUTO_TEST_SUITE_END() // Chunks
+BOOST_AUTO_TEST_SUITE_END() // Get
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests

…ts/chunks/pipeline-interests-cubic.t.cpp tests/get/pipeline-interests-cubic.t.cpptests/chunks/pipeline-interests-cubic.t.cpp renamed to tests/get/pipeline-interests-cubic.t.cpp tests/chunks/pipeline-interests-cubic.t.cpp renamed to tests/get/pipeline-interests-cubic.t.cpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -25,13 +25,11 @@
  * @author Klaus Schneider
  */
 
-#include "tools/chunks/catchunks/pipeline-interests-cubic.hpp"
+#include "tools/get/pipeline-interests-cubic.hpp"
 
 #include "pipeline-interests-fixture.hpp"
 
-namespace ndn::chunks::tests {
-
-using namespace ndn::tests;
+namespace ndn::tests {
 
 class PipelineInterestCubicFixture : public PipelineInterestsFixture
 {
@@ -72,7 +70,7 @@ class PipelineInterestCubicFixture : public PipelineInterestsFixture
   static constexpr double MARGIN = 0.001;
 };
 
-BOOST_AUTO_TEST_SUITE(Chunks)
+BOOST_AUTO_TEST_SUITE(Get)
 BOOST_FIXTURE_TEST_SUITE(TestPipelineInterestsCubic, PipelineInterestCubicFixture)
 
 BOOST_AUTO_TEST_CASE(SlowStart)
@@ -160,7 +158,6 @@ BOOST_AUTO_TEST_CASE(Timeout)
   BOOST_CHECK_EQUAL(pipeline->m_nRetransmitted, 3);
   BOOST_CHECK_EQUAL(pipeline->m_nTimeouts,
       pipeline->m_nRetransmitted + pipeline->m_nSkippedRetx);
-
 }
 
 BOOST_AUTO_TEST_CASE(CongestionMarksWithCwa)
@@ -553,8 +550,7 @@ BOOST_AUTO_TEST_CASE(StopsWhenFileSizeLessThanChunkSize)
   BOOST_CHECK_EQUAL(face.getNPendingInterests(), 0);
 }
 
-
 BOOST_AUTO_TEST_SUITE_END() // TestPipelineInterestsCubic
-BOOST_AUTO_TEST_SUITE_END() // Chunks
+BOOST_AUTO_TEST_SUITE_END() // Get
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests

…ts/chunks/pipeline-interests-fixed.t.cpp tests/get/pipeline-interests-fixed.t.cpptests/chunks/pipeline-interests-fixed.t.cpp renamed to tests/get/pipeline-interests-fixed.t.cpp tests/chunks/pipeline-interests-fixed.t.cpp renamed to tests/get/pipeline-interests-fixed.t.cpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -24,14 +24,14 @@
  * @author Chavoosh Ghasemi
  */
 
-#include "tools/chunks/catchunks/pipeline-interests-fixed.hpp"
-#include "tools/chunks/catchunks/data-fetcher.hpp"
+#include "tools/get/pipeline-interests-fixed.hpp"
+#include "tools/get/data-fetcher.hpp"
 
 #include "pipeline-interests-fixture.hpp"
 
 #include <cmath>
 
-namespace ndn::chunks::tests {
+namespace ndn::tests {
 
 class PipelineInterestFixedFixture : public PipelineInterestsFixture
 {
@@ -58,7 +58,7 @@ class PipelineInterestFixedFixture : public PipelineInterestsFixture
   PipelineInterestsFixed* pipeline;
 };
 
-BOOST_AUTO_TEST_SUITE(Chunks)
+BOOST_AUTO_TEST_SUITE(Get)
 BOOST_FIXTURE_TEST_SUITE(TestPipelineInterestsFixed, PipelineInterestFixedFixture)
 
 BOOST_AUTO_TEST_CASE(FullPipeline)
@@ -296,6 +296,6 @@ BOOST_AUTO_TEST_CASE(CongestionAllSegments)
 }
 
 BOOST_AUTO_TEST_SUITE_END() // TestPipelineInterests
-BOOST_AUTO_TEST_SUITE_END() // Chunks
+BOOST_AUTO_TEST_SUITE_END() // Get
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests

…ts/chunks/pipeline-interests-fixture.hpp tests/get/pipeline-interests-fixture.hpptests/chunks/pipeline-interests-fixture.hpp renamed to tests/get/pipeline-interests-fixture.hpp tests/chunks/pipeline-interests-fixture.hpp renamed to tests/get/pipeline-interests-fixture.hpp

@@ -1,6 +1,6 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
 /*
- * Copyright (c) 2016-2024, Regents of the University of California,
+ * Copyright (c) 2016-2025, Regents of the University of California,
  *                          Colorado State University,
  *                          University Pierre & Marie Curie, Sorbonne University.
  *
@@ -26,19 +26,19 @@
  * @author Chavoosh Ghasemi
  */
 
-#ifndef NDN_TOOLS_TESTS_CHUNKS_PIPELINE_INTERESTS_FIXTURE_HPP
-#define NDN_TOOLS_TESTS_CHUNKS_PIPELINE_INTERESTS_FIXTURE_HPP
+#ifndef NDN_TOOLS_TESTS_GET_PIPELINE_INTERESTS_FIXTURE_HPP
+#define NDN_TOOLS_TESTS_GET_PIPELINE_INTERESTS_FIXTURE_HPP
 
-#include "tools/chunks/catchunks/pipeline-interests.hpp"
+#include "tools/get/pipeline-interests.hpp"
 
 #include "tests/test-common.hpp"
 #include "tests/io-fixture.hpp"
 
 #include <ndn-cxx/util/dummy-client-face.hpp>
 
-namespace ndn::chunks::tests {
+namespace ndn::tests {
 
-using namespace ndn::tests;
+using namespace ndn::get;
 
 class PipelineInterestsFixture : public IoFixture
 {
@@ -86,6 +86,6 @@ class PipelineInterestsFixture : public IoFixture
   std::unique_ptr<PipelineInterests> m_pipeline;
 };
 
-} // namespace ndn::chunks::tests
+} // namespace ndn::tests
 
-#endif // NDN_TOOLS_TESTS_CHUNKS_PIPELINE_INTERESTS_FIXTURE_HPP
+#endif // NDN_TOOLS_TESTS_GET_PIPELINE_INTERESTS_FIXTURE_HPP

tools/chunks/README.md

@@ -1,45 +1,14 @@
-# ndncatchunks and ndnputchunks
+# ndnputchunks
 
-**ndncatchunks** and **ndnputchunks** are a pair of programs to transfer a file as Data segments.
+**ndnputchunks** is a producer program that reads a file from the standard input, and makes
+it available as a set of NDN Data segments. It appends version and segment number components
+to the specified name as needed, according to the [NDN naming conventions](
+https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/).
 
-* **ndnputchunks** is a producer program that reads a file from the standard input, and makes
-  it available as a set of NDN Data segments. It appends version and segment number components
-  to the specified name as needed, according to the [NDN naming conventions](
-  https://named-data.net/publications/techreports/ndn-tr-22-3-ndn-memo-naming-conventions/).
-
-* **ndncatchunks** is a consumer program that fetches Data segments of a file, optionally
-  discovering the latest version of the file, and writes the content of the retrieved file to
-  the standard output.
-
-## Version discovery in ndncatchunks
-
-If a version component is present at the end of the user-specified NDN name, the provided version
-number will be used, without any version discovery process. Otherwise, discovery Interest(s) will
-be sent out to fetch metadata of the solicited content from which the Data version will be resolved.
-For more information about the packet format and naming conventions of Interest and Data packets
-used for version discovery in ndncatchunks, please refer to:
-[Realtime Data Retrieval (RDR) protocol](https://redmine.named-data.net/projects/ndn-tlv/wiki/RDR).
-
-## Interest pipeline types in ndncatchunks
-
-* `fixed`: maintains a fixed-size window of Interests in flight; the window size is configurable
-           via a command line option and defaults to 1.
-
-* `aimd` : adjusts the window size via additive-increase/multiplicative-decrease (AIMD).
-           By default, it uses a Conservative Window Adaptation, that is, the congestion window
-           will be decreased at most once per round-trip-time.
-
-* `cubic`: adjusts the window size similar to the TCP CUBIC algorithm.
-           For details about both aimd and cubic please refer to:
-           [A Practical Congestion Control Scheme for Named Data
-           Networking](https://conferences2.sigcomm.org/acm-icn/2016/proceedings/p21-schneider.pdf).
-
-The default Interest pipeline type is `cubic`.
+Files published by ndnputchunks can be fetched with [ndnget](../get/README.md).
 
 ## Usage examples
 
-### Publishing
-
 The following command will publish the text of the GPL-3 license under the `/localhost/demo/gpl3`
 prefix:
 
@@ -60,17 +29,3 @@ the following command will publish the version 1449078495094 of the `/localhost/
 
 If the specified version component is not valid, ndnputchunks will exit with an error. If no version
 component is specified, one will be generated and appended to the name.
-
-### Retrieval
-
-To retrieve the latest version of a published file, the following command can be used:
-
-    ndncatchunks /localhost/demo/gpl3
-
-To fetch a specific version of a published file, you can specify the version number at the end of
-the name. For example, if the version is known to be 1449078495094, the following command
-will fetch that exact version of the file (without version discovery):
-
-    ndncatchunks -Nt /localhost/demo/gpl3/v=1449078495094
-
-For more information, run the programs with `--help` as argument.