blob: c83ee0f36e9065ca89a6f29ce30a7ebda61a258b [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
21#ifndef CCNX_APP_H
22#define CCNX_APP_H
23
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
29namespace ns3
30{
31
32class Packet;
33class CcnxInterestHeader;
34class CcnxContentObjectHeader;
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080035class CcnxFace;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080036
37/**
38 * @ingroup ccnx
39 * @brief Base class that all CCNx applications should be derived from.
40 *
41 * The class implements virtual calls onInterest, onNack, and onContentObject
42 */
43class CcnxApp: public Application
44{
45public:
Ilya Moiseenko956d0542012-01-02 15:26:40 -080046 /**
47 * \typedef A callback to pass packets to underlying CCNx protocol
48 */
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080049 typedef Callback<bool, const Ptr<const Packet>&> ProtocolHandler;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080050
51 static TypeId GetTypeId ();
52
53 /**
54 * @brief Default constructor
55 */
56 CcnxApp ();
57 virtual ~CcnxApp ();
58
59 /**
60 * @brief Register lower layer callback (to send interests from the application)
61 */
62 void
63 RegisterProtocolHandler (ProtocolHandler handler);
64
65 /**
66 * @brief Method that will be called every time new Interest arrives
67 * @param interest Interest header
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080068 * @param packet "Payload" of the interests packet. The actual payload should be zero, but packet itself
69 * may be useful to get packet tags
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080070 */
71 virtual void
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080072 OnInterest (const Ptr<const CcnxInterestHeader> &interest, Ptr<Packet> packet);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080073
74 /**
75 * @brief Method that will be called every time new NACK arrives
76 * @param interest Interest header
77 */
78 virtual void
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080079 OnNack (const Ptr<const CcnxInterestHeader> &interest, Ptr<Packet> packet);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080080
81 /**
82 * @brief Method that will be called every time new ContentObject arrives
83 * @param contentObject ContentObject header
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080084 * @param payload payload (potentially virtual) of the ContentObject packet (may include packet tags of original packet)
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080085 */
86 virtual void
87 OnContentObject (const Ptr<const CcnxContentObjectHeader> &contentObject,
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -080088 Ptr<Packet> payload);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080089
90protected:
91 virtual void
92 DoDispose ();
93
Alexander Afanasyev06d3a612012-04-17 22:25:40 -070094 // inherited from Application base class. Originally they were private
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080095 virtual void
96 StartApplication (); // Called at time specified by Start
97
98 virtual void
99 StopApplication (); // Called at time specified by Stop
100
101protected:
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800102 ProtocolHandler m_protocolHandler; ///< \brief A callback to pass packets to underlying CCNx protocol
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800103 bool m_active;
Ilya Moiseenko956d0542012-01-02 15:26:40 -0800104 Ptr<CcnxFace> m_face; // local face that is created
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800105
106 TracedCallback<Ptr<const CcnxInterestHeader>,
107 Ptr<CcnxApp>, Ptr<CcnxFace> > m_receivedInterests;
108
109 TracedCallback<Ptr<const CcnxInterestHeader>,
110 Ptr<CcnxApp>, Ptr<CcnxFace> > m_receivedNacks;
111
112 TracedCallback<Ptr<const CcnxContentObjectHeader>, Ptr<const Packet>,
113 Ptr<CcnxApp>, Ptr<CcnxFace> > m_receivedContentObjects;
Alexander Afanasyev15f92992012-04-09 14:56:56 -0700114
115
116 TracedCallback<Ptr<const CcnxInterestHeader>,
117 Ptr<CcnxApp>, Ptr<CcnxFace> > m_transmittedInterests;
118
119 TracedCallback<Ptr<const CcnxContentObjectHeader>, Ptr<const Packet>,
120 Ptr<CcnxApp>, Ptr<CcnxFace> > m_transmittedContentObjects;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800121};
122
123} // namespace ns3
124
125#endif // CCNX_APP_H