blob: b748c2ae1f913bf5028e582556bfcb3ef66c593d [file] [log] [blame]
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 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: Ilya Moiseenko <iliamo@cs.ucla.edu>
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080019 * Alexander Afanasyev <alexander.afanasyev@ucla.edu>
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070020 */
21
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070022#ifndef NDN_CONSUMER_H
23#define NDN_CONSUMER_H
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070024
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070025#include "ndn-app.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080026#include "ns3/random-variable.h"
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -070027#include "ns3/ndn-name.h"
Alexander Afanasyev781ea812011-12-15 22:42:09 -080028#include "ns3/nstime.h"
Alexander Afanasyev011b8592011-12-21 14:45:27 -080029#include "ns3/data-rate.h"
Alexander Afanasyevd9a7f192013-03-07 13:58:14 -080030#include "ns3/ndn-rtt-estimator.h"
Alexander Afanasyev781ea812011-12-15 22:42:09 -080031
32#include <set>
Alexander Afanasyev400aae12013-01-19 13:27:52 -080033#include <map>
Alexander Afanasyev781ea812011-12-15 22:42:09 -080034
35#include <boost/multi_index_container.hpp>
36#include <boost/multi_index/tag.hpp>
37#include <boost/multi_index/ordered_index.hpp>
38#include <boost/multi_index/member.hpp>
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070039
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070040namespace ns3 {
41namespace ndn {
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070042
Ilya Moiseenko956d0542012-01-02 15:26:40 -080043/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070044 * @ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045 * \brief NDN application for sending out Interest packets
Ilya Moiseenko956d0542012-01-02 15:26:40 -080046 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070047class Consumer: public App
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070048{
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080049public:
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070050 static TypeId GetTypeId ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080051
Ilya Moiseenko956d0542012-01-02 15:26:40 -080052 /**
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080053 * \brief Default constructor
Ilya Moiseenko956d0542012-01-02 15:26:40 -080054 * Sets up randomizer function and packet sequence number
55 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070056 Consumer ();
57 virtual ~Consumer () {};
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070058
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070059 // From App
Alexander Afanasyev781ea812011-12-15 22:42:09 -080060 // virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070061 // OnInterest (const Ptr<const Interest> &interest);
Alexander Afanasyev781ea812011-12-15 22:42:09 -080062
63 virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070064 OnNack (const Ptr<const Interest> &interest, Ptr<Packet> packet);
Alexander Afanasyev781ea812011-12-15 22:42:09 -080065
66 virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070067 OnContentObject (const Ptr<const ContentObject> &contentObject,
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080068 Ptr<Packet> payload);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080069
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070070 /**
71 * @brief Timeout event
72 * @param sequenceNumber time outed sequence number
73 */
Alexander Afanasyev359bfb72012-01-09 18:42:50 -080074 virtual void
75 OnTimeout (uint32_t sequenceNumber);
Alexander Afanasyev029d38d2012-01-09 13:50:50 -080076
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070077 /**
78 * @brief Actually send packet
79 */
Alexander Afanasyev029d38d2012-01-09 13:50:50 -080080 void
81 SendPacket ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080082
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070083protected:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070084 // from App
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080085 virtual void
86 StartApplication ();
87
88 virtual void
89 StopApplication ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080090
Ilya Moiseenko956d0542012-01-02 15:26:40 -080091 /**
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070092 * \brief Constructs the Interest packet and sends it using a callback to the underlying NDN protocol
Ilya Moiseenko956d0542012-01-02 15:26:40 -080093 */
Alexander Afanasyev029d38d2012-01-09 13:50:50 -080094 virtual void
95 ScheduleNextPacket () = 0;
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080096
Ilya Moiseenko956d0542012-01-02 15:26:40 -080097 /**
98 * \brief Checks if the packet need to be retransmitted becuase of retransmission timer expiration
99 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800100 void
101 CheckRetxTimeout ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800102
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800103 /**
104 * \brief Modifies the frequency of checking the retransmission timeouts
105 * \param retxTimer Timeout defining how frequent retransmission timeouts should be checked
106 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800107 void
108 SetRetxTimer (Time retxTimer);
109
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800110 /**
111 * \brief Returns the frequency of checking the retransmission timeouts
112 * \return Timeout defining how frequent retransmission timeouts should be checked
113 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800114 Time
115 GetRetxTimer () const;
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800116
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800117protected:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700118 UniformVariable m_rand; ///< @brief nonce generator
Alexander Afanasyev029d38d2012-01-09 13:50:50 -0800119
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700120 uint32_t m_seq; ///< @brief currently requested sequence number
121 uint32_t m_seqMax; ///< @brief maximum number of sequence number
122 EventId m_sendEvent; ///< @brief EventId of pending "send packet" event
123 Time m_retxTimer; ///< @brief Currently estimated retransmission timer
124 EventId m_retxEvent; ///< @brief Event to check whether or not retransmission should be performed
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800125
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700126 Ptr<RttEstimator> m_rtt; ///< @brief RTT estimator
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800127
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800128 Time m_offTime; ///< \brief Time interval between packets
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -0700129 Name m_interestName; ///< \brief NDN Name of the Interest (use Name)
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800130 Time m_interestLifeTime; ///< \brief LifeTime for interest packet
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800131
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800132/// @cond include_hidden
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800133 /**
134 * \struct This struct contains sequence numbers of packets to be retransmitted
135 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800136 struct RetxSeqsContainer :
137 public std::set<uint32_t> { };
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800138
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800139 RetxSeqsContainer m_retxSeqs; ///< \brief ordered set of sequence numbers to be retransmitted
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800140
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800141 /**
142 * \struct This struct contains a pair of packet sequence number and its timeout
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800143 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800144 struct SeqTimeout
145 {
146 SeqTimeout (uint32_t _seq, Time _time) : seq (_seq), time (_time) { }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800147
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800148 uint32_t seq;
149 Time time;
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800150 };
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700151/// @endcond
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800152
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700153/// @cond include_hidden
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800154 class i_seq { };
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800155 class i_timestamp { };
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700156/// @endcond
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800157
Alexander Afanasyev6315ef72012-06-01 20:56:31 -0700158/// @cond include_hidden
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800159 /**
160 * \struct This struct contains a multi-index for the set of SeqTimeout structs
161 */
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800162 struct SeqTimeoutsContainer :
163 public boost::multi_index::multi_index_container<
164 SeqTimeout,
165 boost::multi_index::indexed_by<
166 boost::multi_index::ordered_unique<
167 boost::multi_index::tag<i_seq>,
168 boost::multi_index::member<SeqTimeout, uint32_t, &SeqTimeout::seq>
169 >,
170 boost::multi_index::ordered_non_unique<
171 boost::multi_index::tag<i_timestamp>,
172 boost::multi_index::member<SeqTimeout, Time, &SeqTimeout::time>
173 >
174 >
175 > { } ;
176
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800177 SeqTimeoutsContainer m_seqTimeouts; ///< \brief multi-index for the set of SeqTimeout structs
Alexander Afanasyev400aae12013-01-19 13:27:52 -0800178
179 SeqTimeoutsContainer m_seqLastDelay;
180 SeqTimeoutsContainer m_seqFullDelay;
181 std::map<uint32_t, uint32_t> m_seqRetxCounts;
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800182
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800183 TracedCallback<Ptr<App> /* app */, uint32_t /* seqno */,
184 Time /* delay */, int32_t /*hop count*/> m_lastRetransmittedInterestDataDelay;
185 TracedCallback<Ptr<App> /* app */, uint32_t /* seqno */,
186 Time /* delay */, uint32_t /*retx count*/,
187 int32_t /*hop count*/> m_firstInterestDataDelay;
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800188
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700189/// @endcond
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700190};
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700191
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700192} // namespace ndn
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700193} // namespace ns3
194
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700195#endif