blob: f61d54b9600154c44dec4ab758b60a913fd25b4b [file] [log] [blame]
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -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_APP_H
22#define NDN_APP_H
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080023
24#include "ns3/application.h"
25#include "ns3/ptr.h"
26#include "ns3/callback.h"
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080027#include "ns3/traced-callback.h"
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080028
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070029namespace ns3 {
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080030
31class Packet;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070032
33namespace ndn {
34
35class InterestHeader;
36class ContentObjectHeader;
37class Face;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080038
39/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070040 * @ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070041 * @brief Base class that all NDN applications should be derived from.
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080042 *
43 * The class implements virtual calls onInterest, onNack, and onContentObject
44 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045class App: public Application
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080046{
47public:
Ilya Moiseenko956d0542012-01-02 15:26:40 -080048 /**
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070049 * @brief A callback to pass packets to underlying NDN protocol
Ilya Moiseenko956d0542012-01-02 15:26:40 -080050 */
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080051 typedef Callback<bool, const Ptr<const Packet>&> ProtocolHandler;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080052
53 static TypeId GetTypeId ();
54
55 /**
56 * @brief Default constructor
57 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070058 App ();
59 virtual ~App ();
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080060
61 /**
62 * @brief Register lower layer callback (to send interests from the application)
63 */
64 void
65 RegisterProtocolHandler (ProtocolHandler handler);
66
67 /**
68 * @brief Method that will be called every time new Interest arrives
69 * @param interest Interest header
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080070 * @param packet "Payload" of the interests packet. The actual payload should be zero, but packet itself
71 * may be useful to get packet tags
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080072 */
73 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070074 OnInterest (const Ptr<const InterestHeader> &interest, Ptr<Packet> packet);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080075
76 /**
77 * @brief Method that will be called every time new NACK arrives
78 * @param interest Interest header
79 */
80 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070081 OnNack (const Ptr<const InterestHeader> &interest, Ptr<Packet> packet);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080082
83 /**
84 * @brief Method that will be called every time new ContentObject arrives
85 * @param contentObject ContentObject header
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080086 * @param payload payload (potentially virtual) of the ContentObject packet (may include packet tags of original packet)
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080087 */
88 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070089 OnContentObject (const Ptr<const ContentObjectHeader> &contentObject,
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080090 Ptr<Packet> payload);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080091
92protected:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070093 /**
94 * @brief Do cleanup when application is destroyed
95 */
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080096 virtual void
97 DoDispose ();
98
Alexander Afanasyev06d3a612012-04-17 22:25:40 -070099 // inherited from Application base class. Originally they were private
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800100 virtual void
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700101 StartApplication (); ///< @brief Called at time specified by Start
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800102
103 virtual void
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700104 StopApplication (); ///< @brief Called at time specified by Stop
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800105
106protected:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700107 ProtocolHandler m_protocolHandler; ///< @brief A callback to pass packets to underlying NDN protocol
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700108 bool m_active; ///< @brief Flag to indicate that application is active (set by StartApplication and StopApplication)
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700109 Ptr<Face> m_face; ///< @brief automatically created application face through which application communicates
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800110
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700111 TracedCallback<Ptr<const InterestHeader>,
112 Ptr<App>, Ptr<Face> > m_receivedInterests; ///< @brief App-level trace of received Interests
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800113
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700114 TracedCallback<Ptr<const InterestHeader>,
115 Ptr<App>, Ptr<Face> > m_receivedNacks; ///< @brief App-level trace of received NACKs
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800116
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700117 TracedCallback<Ptr<const ContentObjectHeader>, Ptr<const Packet>,
118 Ptr<App>, Ptr<Face> > m_receivedContentObjects; ///< @brief App-level trace of received Data
Alexander Afanasyev15f92992012-04-09 14:56:56 -0700119
120
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700121 TracedCallback<Ptr<const InterestHeader>,
122 Ptr<App>, Ptr<Face> > m_transmittedInterests; ///< @brief App-level trace of transmitted Interests
Alexander Afanasyev15f92992012-04-09 14:56:56 -0700123
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700124 TracedCallback<Ptr<const ContentObjectHeader>, Ptr<const Packet>,
125 Ptr<App>, Ptr<Face> > m_transmittedContentObjects; ///< @brief App-level trace of transmitted Data
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800126};
127
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700128} // namespace ndn
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800129} // namespace ns3
130
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700131#endif // NDN_APP_H