blob: 8e9e3cec29ac2ecf927de4cb76603658dd3794d8 [file] [log] [blame]
Weiwei Liue4765012016-06-01 00:10:29 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Chavoosh Ghasemi4d36ed52017-10-31 22:26:25 +00002/*
Davide Pesavento5748e822024-01-26 18:40:22 -05003 * Copyright (c) 2016-2024, Regents of the University of California,
Chavoosh Ghasemi4d36ed52017-10-31 22:26:25 +00004 * Colorado State University,
5 * University Pierre & Marie Curie, Sorbonne University.
Weiwei Liue4765012016-06-01 00:10:29 -07006 *
7 * This file is part of ndn-tools (Named Data Networking Essential Tools).
8 * See AUTHORS.md for complete list of ndn-tools authors and contributors.
9 *
10 * ndn-tools is free software: you can redistribute it and/or modify it under the terms
11 * of the GNU General Public License as published by the Free Software Foundation,
12 * either version 3 of the License, or (at your option) any later version.
13 *
14 * ndn-tools is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16 * PURPOSE. See the GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along with
19 * ndn-tools, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
20 *
21 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
22 *
23 * @author Wentao Shang
24 * @author Steve DiBenedetto
25 * @author Andrea Tosatto
26 * @author Davide Pesavento
Chavoosh Ghasemi4d36ed52017-10-31 22:26:25 +000027 * @author Chavoosh Ghasemi
Weiwei Liue4765012016-06-01 00:10:29 -070028 */
29
schneiderklausd8197df2019-03-16 11:31:40 -070030#ifndef NDN_TOOLS_CHUNKS_CATCHUNKS_PIPELINE_INTERESTS_FIXED_HPP
31#define NDN_TOOLS_CHUNKS_CATCHUNKS_PIPELINE_INTERESTS_FIXED_HPP
Chavoosh Ghasemi4d36ed52017-10-31 22:26:25 +000032
Weiwei Liue4765012016-06-01 00:10:29 -070033#include "pipeline-interests.hpp"
34
Davide Pesavento5748e822024-01-26 18:40:22 -050035#include <vector>
36
Davide Pesaventob3570c62022-02-19 19:19:00 -050037namespace ndn::chunks {
Weiwei Liue4765012016-06-01 00:10:29 -070038
39class DataFetcher;
40
Weiwei Liue4765012016-06-01 00:10:29 -070041/**
42 * @brief Service for retrieving Data via an Interest pipeline
43 *
44 * Retrieves all segments of Data under a given prefix by maintaining a fixed-size window of
45 * N Interests in flight. A user-specified callback function is used to notify the arrival of
46 * each segment of Data.
47 *
48 * No guarantees are made as to the order in which segments are fetched or callbacks are invoked,
49 * i.e. out-of-order delivery is possible.
50 */
Davide Pesavento32c0df22019-10-17 12:00:12 -040051class PipelineInterestsFixed final : public PipelineInterests
Weiwei Liue4765012016-06-01 00:10:29 -070052{
53public:
Davide Pesavento97a33b22019-10-17 22:10:47 -040054 PipelineInterestsFixed(Face& face, const Options& opts);
Weiwei Liue4765012016-06-01 00:10:29 -070055
schneiderklausd8197df2019-03-16 11:31:40 -070056 ~PipelineInterestsFixed() final;
Weiwei Liue4765012016-06-01 00:10:29 -070057
58private:
59 /**
60 * @brief fetch all the segments between 0 and m_lastSegmentNo
61 *
62 * Starts a fixed-window pipeline with size equal to m_options.maxPipelineSize. The pipeline
63 * will fetch every segment until the last segment is successfully received or an error occurs.
Weiwei Liue4765012016-06-01 00:10:29 -070064 */
65 void
66 doRun() final;
67
68 void
69 doCancel() final;
70
71 /**
72 * @brief fetch the next segment that has not been requested yet
73 *
74 * @return false if there is an error or all the segments have been fetched, true otherwise
75 */
76 bool
77 fetchNextSegment(size_t pipeNo);
78
79 void
80 handleData(const Interest& interest, const Data& data, size_t pipeNo);
81
82 void
83 handleFail(const std::string& reason, size_t pipeNo);
84
85private:
Davide Pesavento5748e822024-01-26 18:40:22 -050086 std::vector<std::pair<std::shared_ptr<DataFetcher>, uint64_t>> m_segmentFetchers;
Davide Pesaventob587cfd2017-11-04 16:29:50 -040087
Weiwei Liue4765012016-06-01 00:10:29 -070088 /**
89 * true if one or more segment fetchers encountered an error; if m_hasFinalBlockId
90 * is false, this is usually not a fatal error for the pipeline
91 */
Davide Pesavento97a33b22019-10-17 22:10:47 -040092 bool m_hasFailure = false;
Weiwei Liue4765012016-06-01 00:10:29 -070093};
94
Davide Pesaventob3570c62022-02-19 19:19:00 -050095} // namespace ndn::chunks
Chavoosh Ghasemi4d36ed52017-10-31 22:26:25 +000096
schneiderklausd8197df2019-03-16 11:31:40 -070097#endif // NDN_TOOLS_CHUNKS_CATCHUNKS_PIPELINE_INTERESTS_FIXED_HPP