A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 NS_LOG_COMPONENT_DEFINE ("TcpOptionWinScale");
26 namespace ns3 {
27 
28 NS_OBJECT_ENSURE_REGISTERED (TcpOptionWinScale);
29 
31  : TcpOption (),
32  m_scale (0)
33 {
34 }
35 
37 {
38 }
39 
40 TypeId
42 {
43  static TypeId tid = TypeId ("ns3::TcpOptionWinScale")
44  .SetParent<TcpOption> ()
45  .AddConstructor<TcpOptionWinScale> ()
46  ;
47  return tid;
48 }
49 
50 TypeId
52 {
53  return GetTypeId ();
54 }
55 
56 void
57 TcpOptionWinScale::Print (std::ostream &os) const
58 {
59  os << static_cast<int> (m_scale);
60 }
61 
62 uint32_t
64 {
65  return 3;
66 }
67 
68 void
70 {
72  i.WriteU8 (GetKind ()); // Kind
73  i.WriteU8 (3); // Length
74  i.WriteU8 (m_scale); // Max segment size
75 }
76 
77 uint32_t
79 {
81 
82  uint8_t readKind = i.ReadU8 ();
83  if (readKind != GetKind ())
84  {
85  NS_LOG_WARN ("Malformed Window Scale option");
86  return 0;
87  }
88  uint8_t size = i.ReadU8 ();
89  if (size != 3)
90  {
91  NS_LOG_WARN ("Malformed Window Scale option");
92  return 0;
93  }
94  m_scale = i.ReadU8 ();
95  return GetSerializedSize ();
96 }
97 
98 uint8_t
100 {
101  return TcpOption::WINSCALE;
102 }
103 
104 uint8_t
106 {
107  NS_ASSERT (m_scale <= 14);
108 
109  return m_scale;
110 }
111 
112 void
114 {
115  NS_ASSERT (scale <= 14);
116 
117  m_scale = scale;
118 }
119 
120 } // namespace ns3
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register the class in the ns-3 factory.
Definition: object-base.h:38
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:170
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.
void SetScale(uint8_t scale)
Set the scale option.
virtual TypeId GetInstanceTypeId(void) const
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:203
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:49
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:610