/usr/include/ns3.27/ns3/tcp-option-winscale.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 | /* -*- 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>
* Documentation, test cases: Natale Patriciello <natale.patriciello@gmail.com>
*/
#ifndef TCP_OPTION_WINSCALE_H
#define TCP_OPTION_WINSCALE_H
#include "ns3/tcp-option.h"
namespace ns3 {
/**
* \ingroup tcp
*
* \brief Defines the TCP option of kind 3 (window scale option) as in \RFC{1323}
*
* For more efficient use of high bandwidth networks, a larger TCP window size
* may be used. The TCP window size field controls the flow of data and its
* value is limited to between 2 and 65,535 bytes.
*
* Since the size field cannot be expanded, a scaling factor is used.
* The TCP window scale option, as defined in \RFC{1323}, is an option used
* to increase the maximum window size from 65,535 bytes to 1 gigabyte.
* Scaling up to larger window sizes is a part of what is necessary for TCP Tuning.
*
* The window scale option is used only during the TCP 3-way handshake.
* The window scale value represents the number of bits to left-shift the
* 16-bit window size field. The window scale value can be set from 0
* (no shift) to 14 for each direction independently. Both sides must
* send the option in their SYN segments to enable window scaling in
* either direction.
*/
class TcpOptionWinScale : public TcpOption
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
virtual TypeId GetInstanceTypeId (void) const;
TcpOptionWinScale ();
virtual ~TcpOptionWinScale ();
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 scale value (uint8_t)
* \return The scale value
*/
uint8_t GetScale (void) const;
/**
* \brief Set the scale option
*
* The scale option SHOULD be <= 14 (as \RFC{1323}).
*
* \param scale Scale factor
*/
void SetScale (uint8_t scale);
protected:
uint8_t m_scale; //!< Window scaling in number of bit shift
};
} // namespace ns3
#endif /* TCP_OPTION_WINSCALE */
|