ns3::TcpHeader Class Reference
[Tcp]

Header for the Transmission Control Protocol. More...

#include <tcp-header.h>

Inheritance diagram for ns3::TcpHeader:
Inheritance graph
[legend]
Collaboration diagram for ns3::TcpHeader:
Collaboration graph
[legend]

List of all members.

Public Types

enum  Flags_t {
  NONE = 0, FIN = 1, SYN = 2, RST = 4,
  PSH = 8, ACK = 16, URG = 32
}

Public Member Functions

 TcpHeader ()
virtual ~TcpHeader ()
void EnableChecksums (void)
 Enable checksum calculation for TCP (XXX currently has no effect).
void SetSourcePort (uint16_t port)
void SetDestinationPort (uint16_t port)
void SetSequenceNumber (SequenceNumber sequenceNumber)
void SetAckNumber (SequenceNumber ackNumber)
void SetLength (uint8_t length)
void SetFlags (uint8_t flags)
void SetWindowSize (uint16_t windowSize)
void SetUrgentPointer (uint16_t urgentPointer)
uint16_t GetSourcePort () const
uint16_t GetDestinationPort () const
SequenceNumber GetSequenceNumber () const
SequenceNumber GetAckNumber () const
uint8_t GetLength () const
uint8_t GetFlags () const
uint16_t GetWindowSize () const
uint16_t GetUrgentPointer () const
void InitializeChecksum (Ipv4Address source, Ipv4Address destination, uint8_t protocol)
virtual TypeId GetInstanceTypeId (void) const
virtual void Print (std::ostream &os) const
virtual uint32_t GetSerializedSize (void) const
virtual void Serialize (Buffer::Iterator start) const
virtual uint32_t Deserialize (Buffer::Iterator start)
bool IsChecksumOk (void) const
 Is the TCP checksum correct ?

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::TcpHeader.

Private Member Functions

uint16_t CalculateHeaderChecksum (uint16_t size) const

Private Attributes

uint16_t m_sourcePort
uint16_t m_destinationPort
uint32_t m_sequenceNumber
uint32_t m_ackNumber
uint8_t m_length
uint8_t m_flags
uint16_t m_windowSize
uint16_t m_urgentPointer
Ipv4Address m_source
Ipv4Address m_destination
uint8_t m_protocol
uint16_t m_initialChecksum
bool m_calcChecksum
bool m_goodChecksum

Detailed Description

Header for the Transmission Control Protocol.

This class has fields corresponding to those in a network TCP header (port numbers, sequence and acknowledgement numbers, flags, etc) as well as methods for serialization to and deserialization from a byte buffer.

Definition at line 42 of file tcp-header.h.


Member Enumeration Documentation

Enumerator:
NONE 
FIN 
SYN 
RST 
PSH 
ACK 
URG 

Definition at line 136 of file tcp-header.h.


Constructor & Destructor Documentation

ns3::TcpHeader::TcpHeader (  ) 

Definition at line 28 of file tcp-header.cc.

References ns3::NS_OBJECT_ENSURE_REGISTERED().

ns3::TcpHeader::~TcpHeader (  )  [virtual]

Definition at line 41 of file tcp-header.cc.


Member Function Documentation

uint16_t ns3::TcpHeader::CalculateHeaderChecksum ( uint16_t  size  )  const [private]

Definition at line 127 of file tcp-header.cc.

uint32_t ns3::TcpHeader::Deserialize ( Buffer::Iterator  start  )  [virtual]
Parameters:
start an iterator which points to where the header should written.
Returns:
the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Implements ns3::Header.

Definition at line 226 of file tcp-header.cc.

void ns3::TcpHeader::EnableChecksums ( void   ) 

Enable checksum calculation for TCP (XXX currently has no effect).

Definition at line 45 of file tcp-header.cc.

Referenced by ns3::TcpL4Protocol::Receive(), ns3::TcpL4Protocol::Send(), and ns3::TcpL4Protocol::SendPacket().

SequenceNumber ns3::TcpHeader::GetAckNumber (  )  const
uint16_t ns3::TcpHeader::GetDestinationPort (  )  const
Returns:
the destination port for this TcpHeader

Definition at line 87 of file tcp-header.cc.

References m_sourcePort.

Referenced by ns3::TcpL4Protocol::Receive().

uint8_t ns3::TcpHeader::GetFlags (  )  const
TypeId ns3::TcpHeader::GetInstanceTypeId ( void   )  const [virtual]
Returns:
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Definition at line 161 of file tcp-header.cc.

uint8_t ns3::TcpHeader::GetLength ( void   )  const
Returns:
the length of this TcpHeader

Definition at line 99 of file tcp-header.cc.

References m_ackNumber.

SequenceNumber ns3::TcpHeader::GetSequenceNumber ( void   )  const
uint32_t ns3::TcpHeader::GetSerializedSize ( void   )  const [virtual]
Returns:
the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 199 of file tcp-header.cc.

uint16_t ns3::TcpHeader::GetSourcePort (  )  const
Returns:
The source port for this TcpHeader

Definition at line 83 of file tcp-header.cc.

References m_urgentPointer.

Referenced by ns3::TcpL4Protocol::Receive().

TypeId ns3::TcpHeader::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::TcpHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

Definition at line 152 of file tcp-header.cc.

Referenced by Print().

uint16_t ns3::TcpHeader::GetUrgentPointer (  )  const
Returns:
the urgent pointer for this TcpHeader

Definition at line 111 of file tcp-header.cc.

References m_windowSize.

uint16_t ns3::TcpHeader::GetWindowSize (  )  const
Returns:
the window size for this TcpHeader

Definition at line 107 of file tcp-header.cc.

References m_flags.

Referenced by ns3::TcpSocketImpl::ForwardUp().

void ns3::TcpHeader::InitializeChecksum ( Ipv4Address  source,
Ipv4Address  destination,
uint8_t  protocol 
)
Parameters:
source the ip source to use in the underlying ip packet.
destination the ip destination to use in the underlying ip packet.
protocol the protocol number to use in the underlying ip packet.

If you want to use tcp checksums, you should call this method prior to adding the header to a packet.

Definition at line 117 of file tcp-header.cc.

Referenced by ns3::TcpL4Protocol::Receive(), ns3::TcpL4Protocol::Send(), and ns3::TcpL4Protocol::SendPacket().

bool ns3::TcpHeader::IsChecksumOk ( void   )  const

Is the TCP checksum correct ?

Returns:
true if the checksum is correct, false otherwise.

Definition at line 146 of file tcp-header.cc.

Referenced by ns3::TcpL4Protocol::Receive().

void ns3::TcpHeader::Print ( std::ostream &  os  )  const [virtual]

This method is used by Packet::Print to print the content of a trailer as ascii data to a c++ output stream. Although the trailer is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 165 of file tcp-header.cc.

References GetTypeId().

void ns3::TcpHeader::Serialize ( Buffer::Iterator  start  )  const [virtual]
Parameters:
start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 203 of file tcp-header.cc.

References m_length.

void ns3::TcpHeader::SetAckNumber ( SequenceNumber  ackNumber  ) 
Parameters:
ackNumber the ACK number for this TcpHeader

Definition at line 62 of file tcp-header.cc.

References m_sequenceNumber.

Referenced by ns3::TcpSocketImpl::PersistTimeout(), ns3::TcpSocketImpl::Retransmit(), ns3::TcpL4Protocol::Send(), and ns3::TcpSocketImpl::SendPendingData().

void ns3::TcpHeader::SetDestinationPort ( uint16_t  port  ) 
Parameters:
port the destination port for this TcpHeader

Definition at line 54 of file tcp-header.cc.

References m_sourcePort.

Referenced by ns3::TcpSocketImpl::PersistTimeout(), ns3::TcpSocketImpl::Retransmit(), ns3::TcpL4Protocol::Send(), and ns3::TcpSocketImpl::SendPendingData().

void ns3::TcpHeader::SetFlags ( uint8_t  flags  ) 
Parameters:
flags the flags for this TcpHeader

Definition at line 70 of file tcp-header.cc.

References m_length.

Referenced by ns3::TcpSocketImpl::Retransmit(), ns3::TcpL4Protocol::Send(), and ns3::TcpSocketImpl::SendPendingData().

void ns3::TcpHeader::SetLength ( uint8_t  length  ) 
Parameters:
length the length of this TcpHeader

Definition at line 66 of file tcp-header.cc.

References m_ackNumber.

Referenced by ns3::TcpL4Protocol::SendPacket().

void ns3::TcpHeader::SetSequenceNumber ( SequenceNumber  sequenceNumber  ) 
Parameters:
sequenceNumber the sequence number for this TcpHeader

Definition at line 58 of file tcp-header.cc.

References m_destinationPort.

Referenced by ns3::TcpSocketImpl::PersistTimeout(), ns3::TcpSocketImpl::Retransmit(), and ns3::TcpSocketImpl::SendPendingData().

void ns3::TcpHeader::SetSourcePort ( uint16_t  port  ) 
Parameters:
port The source port for this TcpHeader

Definition at line 50 of file tcp-header.cc.

References m_calcChecksum.

Referenced by ns3::TcpSocketImpl::PersistTimeout(), ns3::TcpSocketImpl::Retransmit(), ns3::TcpL4Protocol::Send(), and ns3::TcpSocketImpl::SendPendingData().

void ns3::TcpHeader::SetUrgentPointer ( uint16_t  urgentPointer  ) 
Parameters:
urgentPointer the urgent pointer for this TcpHeader

Definition at line 78 of file tcp-header.cc.

References m_windowSize.

void ns3::TcpHeader::SetWindowSize ( uint16_t  windowSize  ) 
Parameters:
windowSize the window size for this TcpHeader

Definition at line 74 of file tcp-header.cc.

References m_flags.

Referenced by ns3::TcpSocketImpl::PersistTimeout(), ns3::TcpSocketImpl::Retransmit(), and ns3::TcpSocketImpl::SendPendingData().


Member Data Documentation

uint32_t ns3::TcpHeader::m_ackNumber [private]

Definition at line 157 of file tcp-header.h.

Referenced by GetLength(), and SetLength().

Definition at line 168 of file tcp-header.h.

Referenced by SetSourcePort().

Definition at line 164 of file tcp-header.h.

Definition at line 155 of file tcp-header.h.

Referenced by GetSequenceNumber(), and SetSequenceNumber().

uint8_t ns3::TcpHeader::m_flags [private]

Definition at line 159 of file tcp-header.h.

Referenced by GetWindowSize(), and SetWindowSize().

Definition at line 169 of file tcp-header.h.

Definition at line 167 of file tcp-header.h.

uint8_t ns3::TcpHeader::m_length [private]

Definition at line 158 of file tcp-header.h.

Referenced by GetFlags(), Serialize(), and SetFlags().

uint8_t ns3::TcpHeader::m_protocol [private]

Definition at line 165 of file tcp-header.h.

Definition at line 156 of file tcp-header.h.

Referenced by GetAckNumber(), and SetAckNumber().

Definition at line 163 of file tcp-header.h.

uint16_t ns3::TcpHeader::m_sourcePort [private]

Definition at line 154 of file tcp-header.h.

Referenced by GetDestinationPort(), and SetDestinationPort().

uint16_t ns3::TcpHeader::m_urgentPointer [private]

Definition at line 161 of file tcp-header.h.

Referenced by GetSourcePort().

uint16_t ns3::TcpHeader::m_windowSize [private]

Definition at line 160 of file tcp-header.h.

Referenced by GetUrgentPointer(), and SetUrgentPointer().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:47 2009 for NS-3 by  doxygen 1.6.3