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
30namespace ns3 {
31
32class Node;
33
60class Application : public Object
61{
62public:
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
126private:
134 virtual void StartApplication (void);
135
143 virtual void StopApplication (void);
144protected:
145 virtual void DoDispose (void);
146 virtual void DoInitialize (void);
147
153};
154
155} // namespace ns3
156
157#endif /* APPLICATION_H */
a polymophic address class
Definition: address.h:91
The base class for all ns3 applications.
Definition: application.h:61
EventId m_startEvent
The event that will fire at m_startTime to start the application.
Definition: application.h:151
virtual ~Application()
Definition: application.cc:63
void SetNode(Ptr< Node > node)
Definition: application.cc:111
virtual void StartApplication(void)
Application specific startup code.
Definition: application.cc:119
Time m_startTime
The simulation time that the application will start.
Definition: application.h:149
Time m_stopTime
The simulation time that the application will end.
Definition: application.h:150
virtual void DoInitialize(void)
Initialize() implementation.
Definition: application.cc:93
void SetStopTime(Time stop)
Specify application stop time.
Definition: application.cc:75
static TypeId GetTypeId(void)
Get the type ID.
Definition: application.cc:39
void SetStartTime(Time start)
Specify application start time.
Definition: application.cc:69
void(* DelayAddressCallback)(const Time &delay, const Address &from)
Common callback signature for packet delay and address.
Definition: application.h:114
virtual void DoDispose(void)
Destructor implementation.
Definition: application.cc:83
EventId m_stopEvent
The event that will fire at m_stopTime to end the application.
Definition: application.h:152
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
Ptr< Node > GetNode() const
Definition: application.cc:104
virtual void StopApplication(void)
Application specific shutdown code.
Definition: application.cc:124
Ptr< Node > m_node
The node that this application is installed on.
Definition: application.h:148
An identifier for simulation events.
Definition: event-id.h:54
A base class which provides memory management and object aggregation.
Definition: object.h:88
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
def start()
Definition: core.py:1852