Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 1 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */ |
| 2 | /* |
| 3 | * Copyright (c) 2012-2013 University of California, Los Angeles |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
| 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 19 | * Zhenkai Zhu <zhenkai@cs.ucla.edu> |
| 20 | */ |
| 21 | |
| 22 | #ifndef FETCHER_H |
| 23 | #define FETCHER_H |
| 24 | |
Alexander Afanasyev | 49a1852 | 2013-01-18 17:49:04 -0800 | [diff] [blame] | 25 | #include "ccnx-wrapper.h" |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 26 | #include "ccnx-name.h" |
| 27 | |
Alexander Afanasyev | ff8d9dc | 2013-01-26 00:45:08 -0800 | [diff] [blame] | 28 | #include "executor.h" |
Alexander Afanasyev | 83531a4 | 2013-01-19 16:21:54 -0800 | [diff] [blame] | 29 | #include <boost/intrusive/list.hpp> |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 30 | #include <boost/date_time/posix_time/posix_time_types.hpp> |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 31 | |
Alexander Afanasyev | 76d4fa4 | 2013-01-19 14:51:21 -0800 | [diff] [blame] | 32 | class FetchManager; |
| 33 | |
Alexander Afanasyev | 83531a4 | 2013-01-19 16:21:54 -0800 | [diff] [blame] | 34 | class Fetcher |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 35 | { |
| 36 | public: |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 37 | typedef boost::function<void(Ccnx::Name &deviceName, Ccnx::Name &baseName, uint64_t seq, Ccnx::PcoPtr pco)> SegmentCallback; |
| 38 | typedef boost::function<void(Ccnx::Name &deviceName, Ccnx::Name &baseName)> FinishCallback; |
Zhenkai Zhu | da68688 | 2013-01-29 22:32:24 -0800 | [diff] [blame] | 39 | typedef boost::function<void (Fetcher &, const Ccnx::Name &deviceName, const Ccnx::Name &baseName)> OnFetchCompleteCallback; |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 40 | typedef boost::function<void (Fetcher &)> OnFetchFailedCallback; |
| 41 | |
| 42 | Fetcher (Ccnx::CcnxWrapperPtr ccnx, |
Zhenkai Zhu | ab9215c | 2013-01-28 23:42:28 -0800 | [diff] [blame] | 43 | ExecutorPtr executor, |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 44 | const SegmentCallback &segmentCallback, // callback passed by caller of FetchManager |
| 45 | const FinishCallback &finishCallback, // callback passed by caller of FetchManager |
| 46 | OnFetchCompleteCallback onFetchComplete, OnFetchFailedCallback onFetchFailed, // callbacks provided by FetchManager |
| 47 | const Ccnx::Name &deviceName, const Ccnx::Name &name, int64_t minSeqNo, int64_t maxSeqNo, |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 48 | boost::posix_time::time_duration timeout = boost::posix_time::seconds (30), // this time is not precise, but sets min bound |
| 49 | // actual time depends on how fast Interests timeout |
Alexander Afanasyev | 49a1852 | 2013-01-18 17:49:04 -0800 | [diff] [blame] | 50 | const Ccnx::Name &forwardingHint = Ccnx::Name ()); |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 51 | virtual ~Fetcher (); |
Alexander Afanasyev | 76d4fa4 | 2013-01-19 14:51:21 -0800 | [diff] [blame] | 52 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 53 | inline bool |
| 54 | IsActive () const; |
| 55 | |
Zhenkai Zhu | 354d46d | 2013-02-06 13:49:48 -0800 | [diff] [blame] | 56 | inline bool |
| 57 | IsTimedWait() const { return m_timedwait; } |
| 58 | |
Alexander Afanasyev | 76d4fa4 | 2013-01-19 14:51:21 -0800 | [diff] [blame] | 59 | void |
Alexander Afanasyev | 83531a4 | 2013-01-19 16:21:54 -0800 | [diff] [blame] | 60 | RestartPipeline (); |
Alexander Afanasyev | 76d4fa4 | 2013-01-19 14:51:21 -0800 | [diff] [blame] | 61 | |
| 62 | void |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 63 | SetForwardingHint (const Ccnx::Name &forwardingHint); |
| 64 | |
Alexander Afanasyev | ff8d9dc | 2013-01-26 00:45:08 -0800 | [diff] [blame] | 65 | const Ccnx::Name & |
| 66 | GetForwardingHint () const { return m_forwardingHint; } |
| 67 | |
| 68 | const Ccnx::Name & |
| 69 | GetName () const { return m_name; } |
| 70 | |
Alexander Afanasyev | 548d38d | 2013-01-26 16:36:06 -0800 | [diff] [blame] | 71 | const Ccnx::Name & |
| 72 | GetDeviceName () const { return m_deviceName; } |
| 73 | |
| 74 | double |
| 75 | GetRetryPause () const { return m_retryPause; } |
| 76 | |
| 77 | void |
| 78 | SetRetryPause (double pause) { m_retryPause = pause; } |
| 79 | |
| 80 | boost::posix_time::ptime |
| 81 | GetNextScheduledRetry () const { return m_nextScheduledRetry; } |
| 82 | |
| 83 | void |
| 84 | SetNextScheduledRetry (boost::posix_time::ptime nextScheduledRetry) { m_nextScheduledRetry = nextScheduledRetry; } |
Alexander Afanasyev | ff8d9dc | 2013-01-26 00:45:08 -0800 | [diff] [blame] | 85 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 86 | private: |
| 87 | void |
Alexander Afanasyev | 5054789 | 2013-01-19 22:03:45 -0800 | [diff] [blame] | 88 | FillPipeline (); |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 89 | |
| 90 | void |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 91 | OnData (uint64_t seqno, const Ccnx::Name &name, Ccnx::PcoPtr data); |
Alexander Afanasyev | 5054789 | 2013-01-19 22:03:45 -0800 | [diff] [blame] | 92 | |
Zhenkai Zhu | ff4fa8a | 2013-01-28 22:02:40 -0800 | [diff] [blame] | 93 | void |
Alexander Afanasyev | ddc283c | 2013-01-28 23:11:20 -0800 | [diff] [blame] | 94 | OnData_Execute (uint64_t seqno, Ccnx::Name name, Ccnx::PcoPtr data); |
| 95 | |
| 96 | void |
Zhenkai Zhu | ff4fa8a | 2013-01-28 22:02:40 -0800 | [diff] [blame] | 97 | OnTimeout (uint64_t seqno, const Ccnx::Name &name, const Ccnx::Closure &closure, Ccnx::Selectors selectors); |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 98 | |
Alexander Afanasyev | ddc283c | 2013-01-28 23:11:20 -0800 | [diff] [blame] | 99 | void |
Alexander Afanasyev | 67d757c | 2013-01-28 23:22:12 -0800 | [diff] [blame] | 100 | OnTimeout_Execute (uint64_t seqno, Ccnx::Name name, Ccnx::Closure closure, Ccnx::Selectors selectors); |
Alexander Afanasyev | ddc283c | 2013-01-28 23:11:20 -0800 | [diff] [blame] | 101 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 102 | public: |
| 103 | boost::intrusive::list_member_hook<> m_managerListHook; |
| 104 | |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 105 | private: |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 106 | Ccnx::CcnxWrapperPtr m_ccnx; |
| 107 | |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 108 | SegmentCallback m_segmentCallback; |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 109 | OnFetchCompleteCallback m_onFetchComplete; |
| 110 | OnFetchFailedCallback m_onFetchFailed; |
| 111 | |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 112 | FinishCallback m_finishCallback; |
| 113 | |
Alexander Afanasyev | 83531a4 | 2013-01-19 16:21:54 -0800 | [diff] [blame] | 114 | bool m_active; |
Zhenkai Zhu | 354d46d | 2013-02-06 13:49:48 -0800 | [diff] [blame] | 115 | bool m_timedwait; |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 116 | |
Alexander Afanasyev | 49a1852 | 2013-01-18 17:49:04 -0800 | [diff] [blame] | 117 | Ccnx::Name m_name; |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 118 | Ccnx::Name m_deviceName; |
Alexander Afanasyev | 49a1852 | 2013-01-18 17:49:04 -0800 | [diff] [blame] | 119 | Ccnx::Name m_forwardingHint; |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 120 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 121 | boost::posix_time::time_duration m_maximumNoActivityPeriod; |
| 122 | |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 123 | int64_t m_minSendSeqNo; |
| 124 | int64_t m_maxInOrderRecvSeqNo; |
| 125 | std::set<int64_t> m_outOfOrderRecvSeqNo; |
Alexander Afanasyev | cfd5dfc | 2013-01-28 22:21:31 -0800 | [diff] [blame] | 126 | std::set<int64_t> m_inActivePipeline; |
Alexander Afanasyev | 5054789 | 2013-01-19 22:03:45 -0800 | [diff] [blame] | 127 | |
Zhenkai Zhu | 3d1beca | 2013-01-23 14:55:32 -0800 | [diff] [blame] | 128 | int64_t m_minSeqNo; |
| 129 | int64_t m_maxSeqNo; |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 130 | |
Alexander Afanasyev | f9978f8 | 2013-01-23 16:30:31 -0800 | [diff] [blame] | 131 | uint32_t m_pipeline; |
| 132 | uint32_t m_activePipeline; |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 133 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 134 | boost::posix_time::ptime m_lastPositiveActivity; |
Alexander Afanasyev | 548d38d | 2013-01-26 16:36:06 -0800 | [diff] [blame] | 135 | |
| 136 | double m_retryPause; // pause to stop trying to fetch (for fetch-manager) |
| 137 | boost::posix_time::ptime m_nextScheduledRetry; |
Alexander Afanasyev | ca77d4e | 2013-01-28 22:50:05 -0800 | [diff] [blame] | 138 | |
Zhenkai Zhu | ab9215c | 2013-01-28 23:42:28 -0800 | [diff] [blame] | 139 | ExecutorPtr m_executor; // to serialize FillPipeline events |
Alexander Afanasyev | 2ec2c38 | 2013-01-29 20:09:00 -0800 | [diff] [blame] | 140 | |
| 141 | boost::mutex m_seqNoMutex; |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 142 | }; |
| 143 | |
Alexander Afanasyev | d6c2a90 | 2013-01-19 21:24:30 -0800 | [diff] [blame] | 144 | typedef boost::error_info<struct tag_errmsg, std::string> errmsg_info_str; |
Alexander Afanasyev | 49a1852 | 2013-01-18 17:49:04 -0800 | [diff] [blame] | 145 | |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 146 | namespace Error { |
| 147 | struct Fetcher : virtual boost::exception, virtual std::exception { }; |
| 148 | } |
| 149 | |
| 150 | typedef boost::shared_ptr<Fetcher> FetcherPtr; |
| 151 | |
Alexander Afanasyev | 21a166e | 2013-01-20 16:04:41 -0800 | [diff] [blame] | 152 | bool |
| 153 | Fetcher::IsActive () const |
| 154 | { |
| 155 | return m_active; |
| 156 | } |
| 157 | |
Alexander Afanasyev | dfe5819 | 2013-01-17 17:34:04 -0800 | [diff] [blame] | 158 | |
| 159 | #endif // FETCHER_H |