blob: a30cc09daa3db0f6fffa7ad80db3a3ef02f30954 [file] [log] [blame]
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -08001/* -*- 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070021#ifndef NDN_CONSUMER_BATCHES_H
22#define NDN_CONSUMER_BATCHES_H
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080023
Spyridon Mastorakis53e922f2014-10-17 17:29:26 -070024#include "ns3/ndnSIM/model/ndn-common.hpp"
25
Alexander Afanasyev0c395372014-12-20 15:54:02 -080026#include "ndn-consumer.hpp"
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080027#include "ns3/traced-value.h"
Mickey Sweatt89046c12014-11-16 20:32:27 -080028#include "ns3/ndnSIM/utils/batches.hpp"
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080029
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070030namespace ns3 {
31namespace ndn {
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080032
33/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070034 * @ingroup ndn-apps
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070035 * \brief Ndn application for sending out Interest packets in batches
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080036 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080037class ConsumerBatches : public Consumer {
38public:
39 static TypeId
40 GetTypeId();
41
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080042 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080043 * \brief Default constructor
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080044 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080045 ConsumerBatches();
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080046
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080047private:
Alexander Afanasyevc3893b22012-12-11 12:22:00 -080048 virtual void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080049 StartApplication(); ///< @brief Called at time specified by Start
50
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080051 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080052 AddBatch(uint32_t amount);
53
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080054protected:
55 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080056 * \brief Constructs the Interest packet and sends it using a callback to the underlying NDN
57 * protocol
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080058 */
59 virtual void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080060 ScheduleNextPacket();
Alexander Afanasyev3476edf2012-08-14 11:26:00 -070061
62private:
63 bool m_initial;
Alexander Afanasyevc3893b22012-12-11 12:22:00 -080064
65 Batches m_batches;
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080066};
67
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070068} // namespace ndn
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080069} // namespace ns3
70
71#endif