blob: 7ed6a7889a25279e2549f4bb912a7e16d639ebfc [file] [log] [blame]
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2011-2015 Regents of the University of California.
Alexander Afanasyev68de7952012-12-12 18:02:29 -08004 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08005 * This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and
6 * contributors.
Alexander Afanasyev68de7952012-12-12 18:02:29 -08007 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08008 * ndnSIM is free software: you can redistribute it and/or modify it under the terms
9 * of the GNU General Public License as published by the Free Software Foundation,
10 * either version 3 of the License, or (at your option) any later version.
Alexander Afanasyev68de7952012-12-12 18:02:29 -080011 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -080012 * ndnSIM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
13 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
Alexander Afanasyev68de7952012-12-12 18:02:29 -080015 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -080016 * You should have received a copy of the GNU General Public License along with
17 * ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
18 **/
Alexander Afanasyev68de7952012-12-12 18:02:29 -080019
Alexander Afanasyev60a7b622014-12-20 17:04:07 -080020// custom-app.hpp
Alexander Afanasyev68de7952012-12-12 18:02:29 -080021
22#ifndef CUSTOM_APP_H_
23#define CUSTOM_APP_H_
24
Spyridon Mastorakisdb8280f2014-11-21 20:00:17 -080025#include "ns3/ndnSIM/apps/ndn-app.hpp"
Alexander Afanasyev68de7952012-12-12 18:02:29 -080026
27namespace ns3 {
28
29/**
30 * @brief A simple custom application
31 *
Alexander Afanasyev772f51b2013-08-01 18:53:25 -070032 * This applications demonstrates how to send Interests and respond with Datas to incoming interests
Alexander Afanasyev68de7952012-12-12 18:02:29 -080033 *
34 * When application starts it "sets interest filter" (install FIB entry) for /prefix/sub, as well as
35 * sends Interest for this prefix
36 *
Alexander Afanasyev772f51b2013-08-01 18:53:25 -070037 * When an Interest is received, it is replied with a Data with 1024-byte fake payload
Alexander Afanasyev68de7952012-12-12 18:02:29 -080038 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080039class CustomApp : public ndn::App {
Alexander Afanasyev68de7952012-12-12 18:02:29 -080040public:
41 // register NS-3 type "CustomApp"
42 static TypeId
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080043 GetTypeId();
44
Alexander Afanasyev68de7952012-12-12 18:02:29 -080045 // (overridden from ndn::App) Processing upon start of the application
46 virtual void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080047 StartApplication();
Alexander Afanasyev68de7952012-12-12 18:02:29 -080048
49 // (overridden from ndn::App) Processing when application is stopped
50 virtual void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080051 StopApplication();
Alexander Afanasyev68de7952012-12-12 18:02:29 -080052
53 // (overridden from ndn::App) Callback that will be called when Interest arrives
54 virtual void
Alexander Afanasyevafe47fe2015-01-06 18:29:39 -080055 OnInterest(std::shared_ptr<const ndn::Interest> interest);
Alexander Afanasyev68de7952012-12-12 18:02:29 -080056
57 // (overridden from ndn::App) Callback that will be called when Data arrives
58 virtual void
Alexander Afanasyevafe47fe2015-01-06 18:29:39 -080059 OnData(std::shared_ptr<const ndn::Data> contentObject);
Alexander Afanasyev68de7952012-12-12 18:02:29 -080060
61private:
62 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080063 SendInterest();
Alexander Afanasyev68de7952012-12-12 18:02:29 -080064};
65
66} // namespace ns3
67
68#endif // CUSTOM_APP_H_