class for keeping the data sent by the application to the TCP socket, i.e. the sending buffer. More...
#include <tcp-tx-buffer.h>
Public Member Functions | |
| TcpTxBuffer (uint32_t n=0) | |
| SequenceNumber32 | HeadSequence (void) const |
| SequenceNumber32 | TailSequence (void) const |
| uint32_t | Size (void) const |
| uint32_t | MaxBufferSize (void) const |
| void | SetMaxBufferSize (uint32_t n) |
| uint32_t | Available (void) const |
| bool | Add (Ptr< Packet > p) |
| uint32_t | SizeFromSequence (const SequenceNumber32 &seq) const |
| Ptr< Packet > | CopyFromSequence (uint32_t numBytes, const SequenceNumber32 &seq) |
| void | SetHeadSequence (const SequenceNumber32 &seq) |
| void | DiscardUpTo (const SequenceNumber32 &seq) |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| This method returns the TypeId associated to ns3::Object. | |
Detailed Description
class for keeping the data sent by the application to the TCP socket, i.e. the sending buffer.
Member Function Documentation
| bool ns3::TcpTxBuffer::Add | ( | Ptr< Packet > | p | ) |
Append a data packet to the end of the buffer
- Parameters:
-
p The packet to be appended to the Tx buffer
- Returns:
- Boolean to indicate success
References Available(), ns3::Packet::GetSize(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by ns3::TcpSocketBase::Send().
| uint32_t ns3::TcpTxBuffer::Available | ( | void | ) | const |
Returns the available capacity in this Tx window
Referenced by Add(), and ns3::TcpSocketBase::GetTxAvailable().
| Ptr< Packet > ns3::TcpTxBuffer::CopyFromSequence | ( | uint32_t | numBytes, |
| const SequenceNumber32 & | seq | ||
| ) |
Copy data of size numBytes into a packet, data from the range [seq, seq+numBytes)
References ns3::Packet::AddAtEnd(), ns3::Packet::CreateFragment(), ns3::Packet::GetSize(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and SizeFromSequence().
Referenced by ns3::TcpSocketBase::SendDataPacket().
| void ns3::TcpTxBuffer::DiscardUpTo | ( | const SequenceNumber32 & | seq | ) |
Discard data up to but not including this sequence number.
- Parameters:
-
seq The sequence number of the head byte
References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
| TypeId ns3::TcpTxBuffer::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::Object.
This object is accessible through the following paths with Config::Set and Config::Connect:
- /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy
- /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy
No Attributes defined for this type.
No TraceSources defined for this type.
Reimplemented from ns3::Object.
References ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
| SequenceNumber32 ns3::TcpTxBuffer::HeadSequence | ( | void | ) | const |
Returns the first byte's sequence number
Referenced by ns3::TcpTahoe::DupAck(), ns3::TcpNewReno::NewAck(), ns3::TcpSocketBase::ReceivedAck(), ns3::TcpNewReno::Retransmit(), ns3::TcpTahoe::Retransmit(), and ns3::TcpSocketBase::SendPendingData().
| uint32_t ns3::TcpTxBuffer::MaxBufferSize | ( | void | ) | const |
Returns the Tx window size
| void ns3::TcpTxBuffer::SetHeadSequence | ( | const SequenceNumber32 & | seq | ) |
Set the m_firstByteSeq to seq. Supposed to be called only when the connection is just set up and we did not send any data out yet.
References NS_LOG_FUNCTION.
Referenced by ns3::TcpSocketBase::ProcessSynRcvd(), and ns3::TcpSocketBase::ProcessSynSent().
| void ns3::TcpTxBuffer::SetMaxBufferSize | ( | uint32_t | n | ) |
Set the Tx window size
Referenced by ns3::TcpSocketBase::SetSndBufSize().
| uint32_t ns3::TcpTxBuffer::Size | ( | void | ) | const |
Returns total number of bytes in this Tx buffer
Referenced by ns3::TcpSocketBase::ProcessWait(), ns3::TcpSocketBase::Send(), and ns3::TcpSocketBase::SendPendingData().
| uint32_t ns3::TcpTxBuffer::SizeFromSequence | ( | const SequenceNumber32 & | seq | ) | const |
Returns the number of bytes from the buffer in the range [seq, tailSequence)
References NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by ns3::TcpSocketBase::Close(), CopyFromSequence(), ns3::TcpNewReno::DupAck(), ns3::TcpSocketBase::SendDataPacket(), and ns3::TcpSocketBase::SendPendingData().
| SequenceNumber32 ns3::TcpTxBuffer::TailSequence | ( | void | ) | const |
Returns the last byte's sequence number + 1
The documentation for this class was generated from the following files:
- src/internet/model/tcp-tx-buffer.h
- src/internet/model/tcp-tx-buffer.cc
