ns3::TcpHeader Class Reference
[Tcp]

Header for the Transmission Control Protocol. More...

#include <tcp-header.h>

Inheritance diagram for ns3::TcpHeader:

Collaboration diagram for ns3::TcpHeader:

List of all members.

Public Member Functions

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.

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.

Member Function Documentation

virtual 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.

SequenceNumber ns3::TcpHeader::GetAckNumber ( ) const

Returns:: the ACK number for this TcpHeader

uint16_t ns3::TcpHeader::GetDestinationPort ( ) const

Returns:: the destination port for this TcpHeader

uint8_t ns3::TcpHeader::GetFlags ( ) const

Returns:: the flags for this TcpHeader

virtual 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.

uint8_t ns3::TcpHeader::GetLength ( ) const

Returns:: the length of this TcpHeader

SequenceNumber ns3::TcpHeader::GetSequenceNumber ( ) const

Returns:: the sequence number for this TcpHeader

virtual 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.

uint16_t ns3::TcpHeader::GetSourcePort ( ) const

Returns:: The source port for this TcpHeader

static 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.

uint16_t ns3::TcpHeader::GetUrgentPointer ( ) const

Returns:: the urgent pointer for this TcpHeader

uint16_t ns3::TcpHeader::GetWindowSize ( ) const

Returns:: the window size for this TcpHeader

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.

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

Is the TCP checksum correct ?

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

virtual 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.

virtual 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.

void ns3::TcpHeader::SetAckNumber ( SequenceNumber ackNumber )

Parameters:

ackNumber

the ACK number for this TcpHeader

void ns3::TcpHeader::SetDestinationPort ( uint16_t port )

Parameters:

port

the destination port for this TcpHeader

void ns3::TcpHeader::SetFlags ( uint8_t flags )

Parameters:

flags

the flags for this TcpHeader

void ns3::TcpHeader::SetLength ( uint8_t length )

Parameters:

length

the length of this TcpHeader

void ns3::TcpHeader::SetSequenceNumber ( SequenceNumber sequenceNumber )

Parameters:

sequenceNumber

the sequence number for this TcpHeader

void ns3::TcpHeader::SetSourcePort ( uint16_t port )

Parameters:

port

The source port for this TcpHeader

void ns3::TcpHeader::SetUrgentPointer ( uint16_t urgentPointer )

Parameters:

urgentPointer

the urgent pointer for this TcpHeader

void ns3::TcpHeader::SetWindowSize ( uint16_t windowSize )

Parameters:

windowSize

the window size for this TcpHeader

The documentation for this class was generated from the following files:

src/internet-stack/tcp-header.h
doc/introspected-doxygen.h


Public Member Functions
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.

ns3::TcpHeader Class Reference [Tcp]

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

ns3::TcpHeader Class Reference
[Tcp]