A Discrete-Event Network Simulator
API
application.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 Georgia Tech Research Corporation
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: George F. Riley<riley@ece.gatech.edu>
19  */
20 
21 #ifndef APPLICATION_H
22 #define APPLICATION_H
23 
24 #include "ns3/event-id.h"
25 #include "ns3/nstime.h"
26 #include "ns3/object.h"
27 #include "ns3/ptr.h"
28 #include "ns3/node.h"
29 
30 namespace ns3 {
31 
32 class Node;
33 
60 class Application : public Object
61 {
62 public:
67  static TypeId GetTypeId (void);
68  Application ();
69  virtual ~Application ();
70 
82  void SetStartTime (Time start);
83 
95  void SetStopTime (Time stop);
96 
100  Ptr<Node> GetNode () const;
101 
105  void SetNode (Ptr<Node> node);
106 
114  typedef void (*DelayAddressCallback) (const Time &delay,
115  const Address &from);
116 
123  typedef void (*StateTransitionCallback)(const std::string &oldState,
124  const std::string &newState);
125 
126 private:
134  virtual void StartApplication (void);
135 
143  virtual void StopApplication (void);
144 protected:
145  virtual void DoDispose (void);
146  virtual void DoInitialize (void);
147 
153 };
154 
155 } // namespace ns3
156 
157 #endif /* APPLICATION_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::Application::m_node
Ptr< Node > m_node
The node that this application is installed on.
Definition: application.h:148
ns3::Application::m_startEvent
EventId m_startEvent
The event that will fire at m_startTime to start the application.
Definition: application.h:151
ns3::EventId
An identifier for simulation events.
Definition: event-id.h:54
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Application::Application
Application()
Definition: application.cc:57
ns3::Application::m_stopTime
Time m_stopTime
The simulation time that the application will end.
Definition: application.h:150
ns3::Application::StopApplication
virtual void StopApplication(void)
Application specific shutdown code.
Definition: application.cc:124
ns3::Application::DoDispose
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
ns3::Application::SetNode
void SetNode(Ptr< Node > node)
Definition: application.cc:111
ns3::Application::m_stopEvent
EventId m_stopEvent
The event that will fire at m_stopTime to end the application.
Definition: application.h:152
ns3::Application::SetStopTime
void SetStopTime(Time stop)
Specify application stop time.
Definition: application.cc:75
ns3::Ptr< Node >
visualizer.core.start
def start()
Definition: core.py:1853
ns3::Application::SetStartTime
void SetStartTime(Time start)
Specify application start time.
Definition: application.cc:69
ns3::Address
a polymophic address class
Definition: address.h:91
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
ns3::Application::m_startTime
Time m_startTime
The simulation time that the application will start.
Definition: application.h:149
ns3::Application::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: application.cc:39
ns3::Application::~Application
virtual ~Application()
Definition: application.cc:63
ns3::Application::StateTransitionCallback
void(* StateTransitionCallback)(const std::string &oldState, const std::string &newState)
Common signature used by callbacks to application's state transition trace source.
Definition: application.h:123
ns3::Application::GetNode
Ptr< Node > GetNode() const
Definition: application.cc:104
ns3::Application::StartApplication
virtual void StartApplication(void)
Application specific startup code.
Definition: application.cc:119
ns3::Application
The base class for all ns3 applications.
Definition: application.h:61
ns3::Application::DelayAddressCallback
void(* DelayAddressCallback)(const Time &delay, const Address &from)
Common callback signature for packet delay and address.
Definition: application.h:114
ns3::Application::DoInitialize
virtual void DoInitialize(void)
Initialize() implementation.
Definition: application.cc:93