blob: 2871bf2e948711583730d530b6de1ab1186d95ec [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
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070024#include "ndn-consumer.h"
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080025#include "ns3/traced-value.h"
Alexander Afanasyev669cafd2012-11-06 10:17:33 -080026#include "../utils/batches.h"
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080027
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070028namespace ns3 {
29namespace ndn {
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080030
31/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070032 * @ingroup ndn-apps
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070033 * \brief Ndn application for sending out Interest packets in batches
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080034 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070035class ConsumerBatches: public Consumer
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080036{
37public:
38 static TypeId GetTypeId ();
39
40 /**
41 * \brief Default constructor
42 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070043 ConsumerBatches ();
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080044
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045 // From App
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080046 // virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070047 // OnInterest (const Ptr<const Interest> &interest);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080048
49 // virtual void
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -070050 // OnNack (const Ptr<const Interest> &interest);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080051
52 // virtual void
Alexander Afanasyev772f51b2013-08-01 18:53:25 -070053 // OnData (const Ptr<const Data> &contentObject,
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080054 // const Ptr<const Packet> &payload);
55
56 // virtual void
57 // OnTimeout (uint32_t sequenceNumber);
58
59private:
Alexander Afanasyevc3893b22012-12-11 12:22:00 -080060 virtual void
61 StartApplication (); ///< @brief Called at time specified by Start
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080062
63 void
64 AddBatch (uint32_t amount);
65protected:
66 /**
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070067 * \brief Constructs the Interest packet and sends it using a callback to the underlying NDN protocol
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080068 */
69 virtual void
70 ScheduleNextPacket ();
Alexander Afanasyev3476edf2012-08-14 11:26:00 -070071
72private:
73 bool m_initial;
Alexander Afanasyevc3893b22012-12-11 12:22:00 -080074
75 Batches m_batches;
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080076};
77
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070078} // namespace ndn
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080079} // namespace ns3
80
81#endif