A Discrete-Event Network Simulator
API
tcp-option-winscale.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Adrian Sai-wah Tam
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
19  * Documentation, test cases: Natale Patriciello <natale.patriciello@gmail.com>
20  */
21 
22 #include "tcp-option-winscale.h"
23 #include "ns3/log.h"
24 
25 namespace ns3 {
26 
27 NS_LOG_COMPONENT_DEFINE ("TcpOptionWinScale");
28 
29 NS_OBJECT_ENSURE_REGISTERED (TcpOptionWinScale);
30 
32  : TcpOption (),
33  m_scale (0)
34 {
35 }
36 
38 {
39 }
40 
41 TypeId
43 {
44  static TypeId tid = TypeId ("ns3::TcpOptionWinScale")
45  .SetParent<TcpOption> ()
46  .AddConstructor<TcpOptionWinScale> ()
47  ;
48  return tid;
49 }
50 
51 TypeId
53 {
54  return GetTypeId ();
55 }
56 
57 void
58 TcpOptionWinScale::Print (std::ostream &os) const
59 {
60  os << static_cast<int> (m_scale);
61 }
62 
63 uint32_t
65 {
66  return 3;
67 }
68 
69 void
71 {
73  i.WriteU8 (GetKind ()); // Kind
74  i.WriteU8 (3); // Length
75  i.WriteU8 (m_scale); // Max segment size
76 }
77 
78 uint32_t
80 {
82 
83  uint8_t readKind = i.ReadU8 ();
84  if (readKind != GetKind ())
85  {
86  NS_LOG_WARN ("Malformed Window Scale option");
87  return 0;
88  }
89  uint8_t size = i.ReadU8 ();
90  if (size != 3)
91  {
92  NS_LOG_WARN ("Malformed Window Scale option");
93  return 0;
94  }
95  m_scale = i.ReadU8 ();
96  return GetSerializedSize ();
97 }
98 
99 uint8_t
101 {
102  return TcpOption::WINSCALE;
103 }
104 
105 uint8_t
107 {
108  NS_ASSERT (m_scale <= 14);
109 
110  return m_scale;
111 }
112 
113 void
115 {
116  NS_ASSERT (scale <= 14);
117 
118  m_scale = scale;
119 }
120 
121 } // namespace ns3
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
def start()
Definition: core.py:1482
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the Option from a buffer iterator.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
virtual uint8_t GetKind(void) const
Get the `kind' (as in RFC 793) of this option.
iterator in a Buffer instance
Definition: buffer.h:98
uint8_t GetScale(void) const
Get the scale value (uint8_t)
virtual uint32_t GetSerializedSize(void) const
Returns number of bytes required for Option serialization.
virtual void Serialize(Buffer::Iterator start) const
Serialize the Option to a buffer iterator.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetScale(uint8_t scale)
Set the scale option.
virtual TypeId GetInstanceTypeId(void) const
Implement the GetInstanceTypeId method defined in ObjectBase.
void WriteU8(uint8_t data)
Definition: buffer.h:876
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:228
uint8_t ReadU8(void)
Definition: buffer.h:1028
Base class for all kinds of TCP options.
Definition: tcp-option.h:34
uint8_t m_scale
Window scaling in number of bit shift.
a unique identifier for an interface.
Definition: type-id.h:51
static TypeId GetTypeId(void)
Get the type ID.
virtual void Print(std::ostream &os) const
Print the Option contents.
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631