A Discrete-Event Network Simulator
API
application.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2006 Georgia Tech Research Corporation
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: George F. Riley<riley@ece.gatech.edu>
18  */
19 
20 #ifndef APPLICATION_H
21 #define APPLICATION_H
22 
23 #include "node.h"
24 
25 #include "ns3/event-id.h"
26 #include "ns3/nstime.h"
27 #include "ns3/object.h"
28 #include "ns3/ptr.h"
29 
30 namespace ns3
31 {
32 
33 class Node;
34 
61 class Application : public Object
62 {
63  public:
68  static TypeId GetTypeId();
69  Application();
70  ~Application() override;
71 
83  void SetStartTime(Time start);
84 
96  void SetStopTime(Time stop);
97 
101  Ptr<Node> GetNode() const;
102 
106  void SetNode(Ptr<Node> node);
107 
115  typedef void (*DelayAddressCallback)(const Time& delay, const Address& from);
116 
123  typedef void (*StateTransitionCallback)(const std::string& oldState,
124  const std::string& newState);
125 
126  private:
134  virtual void StartApplication();
135 
143  virtual void StopApplication();
144 
145  protected:
146  void DoDispose() override;
147  void DoInitialize() override;
148 
154 };
155 
156 } // namespace ns3
157 
158 #endif /* APPLICATION_H */
a polymophic address class
Definition: address.h:101
The base class for all ns3 applications.
Definition: application.h:62
EventId m_startEvent
The event that will fire at m_startTime to start the application.
Definition: application.h:152
void DoInitialize() override
Initialize() implementation.
Definition: application.cc:96
void SetNode(Ptr< Node > node)
Definition: application.cc:115
void DoDispose() override
Destructor implementation.
Definition: application.cc:86
Time m_startTime
The simulation time that the application will start.
Definition: application.h:150
Time m_stopTime
The simulation time that the application will end.
Definition: application.h:151
~Application() override
Definition: application.cc:66
void SetStopTime(Time stop)
Specify application stop time.
Definition: application.cc:79
virtual void StopApplication()
Application specific shutdown code.
Definition: application.cc:130
virtual void StartApplication()
Application specific startup code.
Definition: application.cc:124
void SetStartTime(Time start)
Specify application start time.
Definition: application.cc:72
void(* DelayAddressCallback)(const Time &delay, const Address &from)
Common callback signature for packet delay and address.
Definition: application.h:115
EventId m_stopEvent
The event that will fire at m_stopTime to end the application.
Definition: application.h:153
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
static TypeId GetTypeId()
Get the type ID.
Definition: application.cc:41
Ptr< Node > GetNode() const
Definition: application.cc:108
Ptr< Node > m_node
The node that this application is installed on.
Definition: application.h:149
An identifier for simulation events.
Definition: event-id.h:55
A base class which provides memory management and object aggregation.
Definition: object.h:89
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.