blob: f177551ef4826821f660956eeaaa6e834c20e199 [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"
26#include "ns3/batches.h"
27
28namespace ns3
29{
30
31/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070032 * @ingroup ndn
33 * \brief Ndn application for sending out Interest packets in batches
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080034 */
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070035class NdnConsumerBatches: public NdnConsumer
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080036{
37public:
38 static TypeId GetTypeId ();
39
40 /**
41 * \brief Default constructor
42 */
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070043 NdnConsumerBatches ();
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080044
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070045 // From NdnApp
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080046 // virtual void
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070047 // OnInterest (const Ptr<const NdnInterestHeader> &interest);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080048
49 // virtual void
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070050 // OnNack (const Ptr<const NdnInterestHeader> &interest);
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080051
52 // virtual void
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070053 // OnContentObject (const Ptr<const NdnContentObjectHeader> &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:
60 Batches
61 GetBatch () const { return Batches(); }
62
63 void
64 SetBatch (const Batches &batch);
65
66 void
67 AddBatch (uint32_t amount);
68protected:
69 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070070 * \brief Constructs the Interest packet and sends it using a callback to the underlying Ndn protocol
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080071 */
72 virtual void
73 ScheduleNextPacket ();
74};
75
76} // namespace ns3
77
78#endif