/usr/include/ns3.27/ns3/delay-jitter-estimation.h is in libns3-dev 3.27+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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 INRIA
*
* 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
*
* Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef DELAY_JITTER_ESTIMATION_H
#define DELAY_JITTER_ESTIMATION_H
#include "ns3/nstime.h"
#include "ns3/packet.h"
namespace ns3 {
/**
* \ingroup stats
*
* \brief quick and dirty delay and jitter estimation
*
*/
class DelayJitterEstimation
{
public:
DelayJitterEstimation ();
/**
* \param packet the packet to send over a wire
*
* This method should be invoked once on each packet to
* record within the packet the tx time which is used upon
* packet reception to calculate the delay and jitter. The
* tx time is stored in the packet as an ns3::Tag which means
* that it does not use any network resources and is not
* taken into account in transmission delay calculations.
*/
static void PrepareTx (Ptr<const Packet> packet);
/**
* \param packet the packet received
*
* Invoke this method to update the delay and jitter calculations
* After a call to this method, \ref GetLastDelay and \ref GetLastJitter
* will return an updated delay and jitter.
*/
void RecordRx (Ptr<const Packet> packet);
/**
* \returns the updated delay.
*/
Time GetLastDelay (void) const;
/**
* The jitter is calculated using the \RFC{1889} (RTP) jitter
* definition.
*
* \returns the updated jitter.
*/
uint64_t GetLastJitter (void) const;
private:
Time m_previousRx; //!< Previous Rx time
Time m_previousRxTx; //!< Previous Rx or Tx time
int64x64_t m_jitter; //!< Jitter estimation
Time m_delay; //!< Delay estimation
};
} // namespace ns3
#endif /* DELAY_JITTER_ESTIMATION_H */
|