Header for the Transmission Control Protocol.
More...
#include <tcp-header.h>
List of all members.
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.
| uint16_t ns3::TcpHeader::GetDestinationPort |
( |
|
) |
const |
- Returns:
- the destination port for this TcpHeader
| uint8_t ns3::TcpHeader::GetFlags |
( |
|
) |
const |
| virtual TypeId ns3::TcpHeader::GetInstanceTypeId |
( |
void |
|
) |
const [virtual] |
| uint8_t ns3::TcpHeader::GetLength |
( |
|
) |
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 |
| 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 |
- 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::SetDestinationPort |
( |
uint16_t |
port |
) |
|
| void ns3::TcpHeader::SetFlags |
( |
uint8_t |
flags |
) |
|
| void ns3::TcpHeader::SetLength |
( |
uint8_t |
length |
) |
|
| void ns3::TcpHeader::SetSequenceNumber |
( |
SequenceNumber |
sequenceNumber |
) |
|
- Parameters:
-
| sequenceNumber | the sequence number for this TcpHeader |
| void ns3::TcpHeader::SetSourcePort |
( |
uint16_t |
port |
) |
|
| 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
