/usr/include/ns3.27/ns3/tcp-option-ts.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 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 107 108 109 110 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2011 Adrian Sai-wah Tam
*
* 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: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
*/
#ifndef TCP_OPTION_TS_H
#define TCP_OPTION_TS_H
#include "ns3/tcp-option.h"
#include "ns3/timer.h"
namespace ns3 {
/**
* \ingroup tcp
*
* Defines the TCP option of kind 8 (timestamp option) as in \RFC{1323}
*/
class TcpOptionTS : public TcpOption
{
public:
TcpOptionTS ();
virtual ~TcpOptionTS ();
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
virtual void Print (std::ostream &os) const;
virtual void Serialize (Buffer::Iterator start) const;
virtual uint32_t Deserialize (Buffer::Iterator start);
virtual uint8_t GetKind (void) const;
virtual uint32_t GetSerializedSize (void) const;
/**
* \brief Get the timestamp stored in the Option
* \return the timestamp
*/
uint32_t GetTimestamp (void) const;
/**
* \brief Get the timestamp echo stored in the Option
* \return the timestamp echo
*/
uint32_t GetEcho (void) const;
/**
* \brief Set the timestamp stored in the Option
* \param ts the timestamp
*/
void SetTimestamp (uint32_t ts);
/**
* \brief Set the timestamp echo stored in the Option
* \param ts the timestamp echo
*/
void SetEcho (uint32_t ts);
/**
* \brief Return an uint32_t value which represent "now"
*
* The value returned is usually used as Timestamp option for the
* TCP header; when the value will be echoed back, calculating the RTT
* will be an easy matter.
*
* The RFC does not mention any units for this value; following what
* is implemented in OS, we use milliseconds. Any change to this must be
* reflected to EstimateRttFromTs.
*
* \see EstimateRttFromTs
* \return The Timestamp value to use
*/
static uint32_t NowToTsValue ();
/**
* \brief Estimate the Time elapsed from a TS echo value
*
* The echoTime should be a value returned from NowToTsValue.
*
* \param echoTime Echoed value from other side
* \see NowToTsValue
* \return The measured RTT
*/
static Time ElapsedTimeFromTsValue (uint32_t echoTime);
protected:
uint32_t m_timestamp; //!< local timestamp
uint32_t m_echo; //!< echo timestamp
};
} // namespace ns3
#endif /* TCP_OPTION_TS */
|