A Discrete-Event Network Simulator
API
onoff-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// ns3 - On/Off Data Source Application class
21// George F. Riley, Georgia Tech, Spring 2007
22// Adapted from ApplicationOnOff in GTNetS.
23
24#ifndef ONOFF_APPLICATION_H
25#define ONOFF_APPLICATION_H
26
27#include "ns3/address.h"
28#include "ns3/application.h"
29#include "ns3/data-rate.h"
30#include "ns3/event-id.h"
31#include "ns3/ptr.h"
32#include "ns3/seq-ts-size-header.h"
33#include "ns3/traced-callback.h"
34
35namespace ns3
36{
37
38class Address;
39class RandomVariableStream;
40class Socket;
41
96{
97 public:
102 static TypeId GetTypeId();
103
105
106 ~OnOffApplication() override;
107
116 void SetMaxBytes(uint64_t maxBytes);
117
122 Ptr<Socket> GetSocket() const;
123
131 int64_t AssignStreams(int64_t stream);
132
133 protected:
134 void DoDispose() override;
135
136 private:
137 // inherited from Application base class.
138 void StartApplication() override; // Called at time specified by Start
139 void StopApplication() override; // Called at time specified by Stop
140
141 // helpers
145 void CancelEvents();
146
147 // Event handlers
151 void StartSending();
155 void StopSending();
159 void SendPacket();
160
172 uint64_t m_maxBytes;
173 uint64_t m_totBytes;
180
183
186
191
192 private:
196 void ScheduleNextTx();
200 void ScheduleStartEvent();
204 void ScheduleStopEvent();
209 void ConnectionSucceeded(Ptr<Socket> socket);
214 void ConnectionFailed(Ptr<Socket> socket);
215};
216
217} // namespace ns3
218
219#endif /* ONOFF_APPLICATION_H */
a polymophic address class
Definition: address.h:100
The base class for all ns3 applications.
Definition: application.h:61
Class for representing data rates.
Definition: data-rate.h:90
An identifier for simulation events.
Definition: event-id.h:55
Generate traffic to a single destination according to an OnOff pattern.
static TypeId GetTypeId()
Get the type ID.
uint32_t m_residualBits
Number of generated, but not sent, bits.
void ConnectionSucceeded(Ptr< Socket > socket)
Handle a Connection Succeed event.
EventId m_sendEvent
Event id of pending "send packet" event.
void ScheduleStartEvent()
Schedule the next On period start.
bool m_connected
True if connected.
uint32_t m_pktSize
Size of packets.
Ptr< Socket > GetSocket() const
Return a pointer to associated socket.
Ptr< Socket > m_socket
Associated socket.
TracedCallback< Ptr< const Packet > > m_txTrace
Traced Callback: transmitted packets.
void SetMaxBytes(uint64_t maxBytes)
Set the total number of bytes to send.
Ptr< RandomVariableStream > m_offTime
rng for Off Time
void StartApplication() override
Application specific startup code.
Ptr< Packet > m_unsentPacket
Unsent packet cached for future attempt.
TracedCallback< Ptr< const Packet >, const Address &, const Address & > m_txTraceWithAddresses
Callbacks for tracing the packet Tx events, includes source and destination addresses.
void DoDispose() override
Destructor implementation.
EventId m_startStopEvent
Event id for next start or stop event.
void ScheduleNextTx()
Schedule the next packet transmission.
DataRate m_cbrRateFailSafe
Rate that data is generated (check copy)
void ConnectionFailed(Ptr< Socket > socket)
Handle a Connection Failed event.
void ScheduleStopEvent()
Schedule the next Off period start.
TracedCallback< Ptr< const Packet >, const Address &, const Address &, const SeqTsSizeHeader & > m_txTraceWithSeqTsSize
Callback for tracing the packet Tx events, includes source, destination, the packet sent,...
uint64_t m_maxBytes
Limit total number of bytes sent.
Time m_lastStartTime
Time last packet sent.
uint64_t m_totBytes
Total bytes sent so far.
void StopSending()
Start an Off period.
void StartSending()
Start an On period.
Address m_local
Local address to bind to.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Ptr< RandomVariableStream > m_onTime
rng for On Time
bool m_enableSeqTsSizeHeader
Enable or disable the use of SeqTsSizeHeader.
TypeId m_tid
Type of the socket used.
uint32_t m_seq
Sequence.
DataRate m_cbrRate
Rate that data is generated.
void StopApplication() override
Application specific shutdown code.
Address m_peer
Peer address.
void CancelEvents()
Cancel all pending events.
void SendPacket()
Send a packet.
Header with a sequence, a timestamp, and a "size" attribute.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.