/usr/include/ns3/bulk-send-application.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2010 Georgia Institute of Technology
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: George F. Riley <riley@ece.gatech.edu>
*/
#ifndef BULK_SEND_APPLICATION_H
#define BULK_SEND_APPLICATION_H
#include "ns3/address.h"
#include "ns3/application.h"
#include "ns3/event-id.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
namespace ns3 {
class Address;
class RandomVariable;
class Socket;
/**
* \ingroup applications
* \defgroup bulksend BulkSendApplication
*
* This traffic generator simply sends data
* as fast as possible up to MaxBytes or until
* the appplication is stopped if MaxBytes is
* zero. Once the lower layer send buffer is
* filled, it waits until space is free to
* send more data, essentially keeping a
* constant flow of data. Only SOCK_STREAM
* and SOCK_SEQPACKET sockets are supported.
* For example, TCP sockets can be used, but
* UDP sockets can not be used.
*/
class BulkSendApplication : public Application
{
public:
static TypeId GetTypeId (void);
BulkSendApplication ();
virtual ~BulkSendApplication ();
/**
* \param maxBytes the upper bound of bytes to send
*
* Set the upper bound for the total number of bytes to send. Once
* this bound is reached, no more application bytes are sent. If the
* application is stopped during the simulation and restarted, the
* total number of bytes sent is not reset; however, the maxBytes
* bound is still effective and the application will continue sending
* up to maxBytes. The value zero for maxBytes means that
* there is no upper bound; i.e. data is sent until the application
* or simulation is stopped.
*/
void SetMaxBytes (uint32_t maxBytes);
/**
* \return pointer to associated socket
*/
Ptr<Socket> GetSocket (void) const;
protected:
virtual void DoDispose (void);
private:
// inherited from Application base class.
virtual void StartApplication (void); // Called at time specified by Start
virtual void StopApplication (void); // Called at time specified by Stop
void SendData ();
Ptr<Socket> m_socket; // Associated socket
Address m_peer; // Peer address
bool m_connected; // True if connected
uint32_t m_sendSize; // Size of data to send each time
uint32_t m_maxBytes; // Limit total number of bytes sent
uint32_t m_totBytes; // Total bytes sent so far
TypeId m_tid;
TracedCallback<Ptr<const Packet> > m_txTrace;
private:
void ConnectionSucceeded (Ptr<Socket> socket);
void ConnectionFailed (Ptr<Socket> socket);
void DataSend (Ptr<Socket>, uint32_t); // for socket's SetSendCallback
void Ignore (Ptr<Socket> socket);
};
} // namespace ns3
#endif /* BULK_SEND_APPLICATION_H */
|