A Discrete-Event Network Simulator
API
TcpFastRetrTest Class Reference

Test the fast retransmission. More...

+ Inheritance diagram for TcpFastRetrTest:
+ Collaboration diagram for TcpFastRetrTest:

Public Member Functions

 TcpFastRetrTest (TypeId congControl, uint32_t seqToKill, const std::string &msg)
 Constructor. More...
 
virtual Ptr< ErrorModelCreateReceiverErrorModel ()
 Create and return the error model to install in the receiver node. More...
 
virtual Ptr< ErrorModelCreateSenderErrorModel ()
 Create and return the error model to install in the sender node. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSenderSocket (Ptr< Node > node)
 Create and install the socket to install on the sender. More...
 
- Public Member Functions inherited from ns3::TcpGeneralTest
 TcpGeneralTest (const std::string &desc)
 TcpGeneralTest constructor. More...
 
 ~TcpGeneralTest ()
 
- Public Member Functions inherited from ns3::TestCase
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 

Protected Member Functions

virtual void AfterRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
 Rto has expired. More...
 
virtual void ConfigureEnvironment ()
 Change the configuration of the environment. More...
 
virtual void ConfigureProperties ()
 Change the configuration of the socket properties. More...
 
virtual void CongStateTrace (const TcpSocketState::TcpCongState_t oldValue, const TcpSocketState::TcpCongState_t newValue)
 State on Ack state machine changes. More...
 
virtual void FinalChecks ()
 Performs the (eventual) final checks through test asserts. More...
 
void PktDropped (const Ipv4Header &ipH, const TcpHeader &tcpH, Ptr< const Packet > p)
 Check if the packet being dropped is the right one. More...
 
virtual void ProcessedAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Processed ack. More...
 
virtual void RcvAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Received ack. More...
 
virtual void Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet received from IP layer. More...
 
virtual void Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet transmitted down to IP layer. More...
 
- Protected Member Functions inherited from ns3::TcpGeneralTest
virtual void BeforeRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
 Rto has expired. More...
 
virtual void BytesInFlightTrace (uint32_t oldValue, uint32_t newValue)
 Bytes in flight changes. More...
 
virtual Ptr< SimpleChannelCreateChannel ()
 Create and return the channel installed between the two socket. More...
 
virtual Ptr< TcpSocketMsgBaseCreateReceiverSocket (Ptr< Node > node)
 Create and install the socket to install on the receiver. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl)
 Create a socket. More...
 
virtual Ptr< TcpSocketMsgBaseCreateSocket (Ptr< Node > node, TypeId socketType, TypeId congControl, TypeId recoveryAlgorithm)
 Create a socket. More...
 
virtual void CWndInflTrace (uint32_t oldValue, uint32_t newValue)
 Tracks the inflated congestion window changes. More...
 
virtual void CWndTrace (uint32_t oldValue, uint32_t newValue)
 Tracks the congestion window changes. More...
 
virtual void DataSent (uint32_t size, SocketWho who)
 Notifying application for sent data. More...
 
void DoConnect ()
 Scheduled at 0.0, SENDER starts the connection to RECEIVER. More...
 
virtual void DoRun (void)
 Execute the tcp test. More...
 
virtual void DoTeardown (void)
 Teardown the TCP test. More...
 
virtual void ErrorClose (SocketWho who)
 Socket closed with an error. More...
 
Time GetClockGranularity (SocketWho who)
 Get the clock granularity attribute. More...
 
Time GetConnTimeout (SocketWho who)
 Get the retransmission time for the SYN segments. More...
 
uint32_t GetDelAckCount (SocketWho who)
 Get the number of delayed ack (if present) More...
 
Time GetDelAckTimeout (SocketWho who)
 Get the timeout of delayed ack (if present) More...
 
uint32_t GetDupAckCount (SocketWho who)
 Get the number of dupack received. More...
 
SequenceNumber32 GetHighestTxMark (SocketWho who)
 Get the highest tx mark of the node specified. More...
 
uint32_t GetInitialCwnd (SocketWho who)
 Get the initial congestion window. More...
 
uint32_t GetInitialSsThresh (SocketWho who)
 Get the initial slow start threshold. More...
 
Time GetMinRto (SocketWho who)
 Get the minimum RTO attribute. More...
 
uint32_t GetMtu () const
 Get the MTU of the environment. More...
 
EventId GetPersistentEvent (SocketWho who)
 Get the persistent event of the selected socket. More...
 
Time GetPersistentTimeout (SocketWho who)
 Get the persistent timeout of the selected socket. More...
 
uint32_t GetPktCount () const
 Get the number of application packets. More...
 
Time GetPktInterval () const
 Get the interval to wait for each packet sent down from application to TCP. More...
 
uint32_t GetPktSize () const
 Get the application packet size. More...
 
Time GetPropagationDelay () const
 Get the channel Propagation Delay. More...
 
Ptr< TcpSocketMsgBaseGetReceiverSocket ()
 Get the pointer to a previously created receiver socket. More...
 
uint32_t GetReTxThreshold (SocketWho who)
 Get the retransmission threshold. More...
 
Time GetRto (SocketWho who)
 Get the retransmission time. More...
 
Ptr< RttEstimatorGetRttEstimator (SocketWho who)
 Get the Rtt estimator of the socket. More...
 
uint32_t GetRWnd (SocketWho who)
 Get the rWnd of the selected socket. More...
 
Ptr< TcpRxBufferGetRxBuffer (SocketWho who)
 Get the Rx buffer from selected socket. More...
 
uint32_t GetSegSize (SocketWho who)
 Get the segment size of the node specified. More...
 
Ptr< TcpSocketMsgBaseGetSenderSocket ()
 Get the pointer to a previously created sender socket. More...
 
Time GetStartTime () const
 Get the data start time. More...
 
Ptr< TcpSocketStateGetTcb (SocketWho who)
 Get the TCB from selected socket. More...
 
TcpSocket::TcpStates_t GetTcpState (SocketWho who)
 Get the state of the TCP state machine. More...
 
Ptr< TcpTxBufferGetTxBuffer (SocketWho who)
 Get the Tx buffer from selected socket. More...
 
virtual void HighestTxSeqTrace (SequenceNumber32 oldValue, SequenceNumber32 newValue)
 Highest tx seq changes. More...
 
virtual void NextTxSeqTrace (SequenceNumber32 oldValue, SequenceNumber32 newValue)
 Next tx seq changes. More...
 
virtual void NormalClose (SocketWho who)
 Socket closed normally. More...
 
virtual void PhyDrop (SocketWho who)
 Link drop. More...
 
virtual void QueueDrop (SocketWho who)
 Drop on the queue. More...
 
virtual void RateSampleUpdatedTrace (const TcpRateLinux::TcpRateSample &sample)
 Track the rate sample value of TcpRateLinux. More...
 
virtual void RateUpdatedTrace (const TcpRateLinux::TcpRateConnection &rate)
 Track the rate value of TcpRateLinux. More...
 
virtual void ReceivePacket (Ptr< Socket > socket)
 Packet received. More...
 
virtual void RtoTrace (Time oldValue, Time newValue)
 RTO changes. More...
 
virtual void RttTrace (Time oldTime, Time newTime)
 Rtt changes. More...
 
void SendPacket (Ptr< Socket > socket, uint32_t pktSize, uint32_t pktCount, Time pktInterval)
 Send packets to other endpoint. More...
 
void SetAppPktCount (uint32_t pktCount)
 Set app packet count. More...
 
void SetAppPktInterval (Time pktInterval)
 Interval between app-generated packet. More...
 
void SetAppPktSize (uint32_t pktSize)
 Set app packet size. More...
 
void SetCongestionControl (TypeId congControl)
 Congestion control of the sender socket. More...
 
void SetDelAckMaxCount (SocketWho who, uint32_t count)
 Forcefully set the delayed acknowledgement count. More...
 
void SetInitialCwnd (SocketWho who, uint32_t initialCwnd)
 Forcefully set the initial cwnd. More...
 
void SetInitialSsThresh (SocketWho who, uint32_t initialSsThresh)
 Forcefully set the initial ssthresh. More...
 
void SetMTU (uint32_t mtu)
 MTU of the bottleneck link. More...
 
void SetPropagationDelay (Time propDelay)
 Propagation delay of the bottleneck link. More...
 
void SetRcvBufSize (SocketWho who, uint32_t size)
 Forcefully set a defined size for rx buffer. More...
 
void SetRecoveryAlgorithm (TypeId reccovery)
 recovery algorithm of the sender socket More...
 
void SetSegmentSize (SocketWho who, uint32_t segmentSize)
 Forcefully set the segment size. More...
 
void SetTransmitStart (Time startTime)
 Set the initial time at which the application sends the first data packet. More...
 
void SetUseEcn (SocketWho who, TcpSocketState::UseEcn_t useEcn)
 Forcefully set the ECN mode of use. More...
 
virtual void SsThreshTrace (uint32_t oldValue, uint32_t newValue)
 Slow start threshold changes. More...
 
virtual void UpdatedRttHistory (const SequenceNumber32 &seq, uint32_t sz, bool isRetransmission, SocketWho who)
 Updated the Rtt history. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCaseGetParent () const
 Get the parent of this TestCsse. More...
 
bool IsStatusFailure (void) const
 Check if any tests failed. More...
 
bool IsStatusSuccess (void) const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
void ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
 Log the failure of this TestCase. More...
 
bool MustAssertOnFailure (void) const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure (void) const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

Protected Attributes

uint32_t m_bytesRcvButNotAcked
 Number of bytes received but not acked. More...
 
uint32_t m_countRetr
 Retry counter. More...
 
uint32_t m_dupAckReceived
 DipACk received. More...
 
Ptr< TcpSeqErrorModelm_errorModel
 Error model. More...
 
bool m_pktDropped
 The packet has been dropped. More...
 
bool m_pktWasDropped
 The packet was dropped (according to the receiver). More...
 
SequenceNumber32 m_previousAck
 Previous ACK received. More...
 
SequenceNumber32 m_rcvNextExpAck
 Receiver next expected sequence number. More...
 
uint32_t m_seqToKill
 Sequence number to drop. More...
 
SequenceNumber32 m_sndNextExpSeq
 Sender next expected sequence number. More...
 
- Protected Attributes inherited from ns3::TcpGeneralTest
TypeId m_congControlTypeId
 Congestion control. More...
 
TypeId m_recoveryTypeId
 Recovery. More...
 

Additional Inherited Members

- Public Types inherited from ns3::TcpGeneralTest
enum  SocketWho { SENDER, RECEIVER }
 Used as parameter of methods, specifies on what node the caller is interested (e.g. More...
 
- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1, EXTENSIVE = 2, TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 

Detailed Description

Test the fast retransmission.

Checking what is happening is not so easy, so there are a lot of variables which helps to keep track on what is happening. The idea is following sequence and ack numbers which are exchanged, testing if they are the same as the implementation transmits.

Definition at line 41 of file tcp-fast-retr-test.cc.

Constructor & Destructor Documentation

◆ TcpFastRetrTest()

TcpFastRetrTest::TcpFastRetrTest ( TypeId  congControl,
uint32_t  seqToKill,
const std::string &  msg 
)

Constructor.

Parameters
congControlType of congestion control.
seqToKillSequence number of the packet to drop.
msgTest message.

Definition at line 99 of file tcp-fast-retr-test.cc.

References ns3::TcpGeneralTest::m_congControlTypeId.

Member Function Documentation

◆ AfterRTOExpired()

void TcpFastRetrTest::AfterRTOExpired ( const Ptr< const TcpSocketState tcb,
SocketWho  who 
)
protectedvirtual

Rto has expired.

Parameters
tcbTransmission control block
whowhere the RTO has expired (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 376 of file tcp-fast-retr-test.cc.

References NS_ASSERT_MSG().

+ Here is the call graph for this function:

◆ ConfigureEnvironment()

void TcpFastRetrTest::ConfigureEnvironment ( void  )
protectedvirtual

Change the configuration of the environment.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 122 of file tcp-fast-retr-test.cc.

References ns3::TcpGeneralTest::SetAppPktCount().

+ Here is the call graph for this function:

◆ ConfigureProperties()

void TcpFastRetrTest::ConfigureProperties ( void  )
protectedvirtual

Change the configuration of the socket properties.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 115 of file tcp-fast-retr-test.cc.

References ns3::TcpGeneralTest::SENDER, and ns3::TcpGeneralTest::SetInitialSsThresh().

+ Here is the call graph for this function:

◆ CongStateTrace()

void TcpFastRetrTest::CongStateTrace ( const TcpSocketState::TcpCongState_t  oldValue,
const TcpSocketState::TcpCongState_t  newValue 
)
protectedvirtual

State on Ack state machine changes.

Parameters
oldValueold value
newValuenew value

Reimplemented from ns3::TcpGeneralTest.

Definition at line 382 of file tcp-fast-retr-test.cc.

References ns3::TcpGeneralTest::GetDupAckCount(), ns3::TcpGeneralTest::GetReTxThreshold(), NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ CreateReceiverErrorModel()

Ptr< ErrorModel > TcpFastRetrTest::CreateReceiverErrorModel ( )
virtual

Create and return the error model to install in the receiver node.

Returns
receiver error model

Reimplemented from ns3::TcpGeneralTest.

Definition at line 135 of file tcp-fast-retr-test.cc.

References ns3::TcpSeqErrorModel::AddSeqToKill(), m_errorModel, m_seqToKill, ns3::MakeCallback(), PktDropped(), and ns3::TcpGeneralErrorModel::SetDropCallback().

+ Here is the call graph for this function:

◆ CreateSenderErrorModel()

Ptr< ErrorModel > TcpFastRetrTest::CreateSenderErrorModel ( )
virtual

Create and return the error model to install in the sender node.

Returns
sender error model

Reimplemented from ns3::TcpGeneralTest.

Definition at line 129 of file tcp-fast-retr-test.cc.

◆ CreateSenderSocket()

Ptr< TcpSocketMsgBase > TcpFastRetrTest::CreateSenderSocket ( Ptr< Node node)
virtual

Create and install the socket to install on the sender.

Parameters
nodesender node pointer
Returns
the socket to be installed in the sender

Reimplemented from ns3::TcpGeneralTest.

Definition at line 146 of file tcp-fast-retr-test.cc.

References ns3::Seconds(), and ns3::ObjectBase::SetAttribute().

+ Here is the call graph for this function:

◆ FinalChecks()

void TcpFastRetrTest::FinalChecks ( void  )
protectedvirtual

Performs the (eventual) final checks through test asserts.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 420 of file tcp-fast-retr-test.cc.

References ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_countRetr, m_pktWasDropped, m_rcvNextExpAck, and NS_TEST_ASSERT_MSG_EQ.

+ Here is the call graph for this function:

◆ PktDropped()

void TcpFastRetrTest::PktDropped ( const Ipv4Header ipH,
const TcpHeader tcpH,
Ptr< const Packet p 
)
protected

Check if the packet being dropped is the right one.

Parameters
ipHIPv4 header.
tcpHTCP header.
pThe packet.

Definition at line 408 of file tcp-fast-retr-test.cc.

References ns3::TcpHeader::GetSequenceNumber(), m_pktDropped, m_rcvNextExpAck, m_seqToKill, NS_LOG_FUNCTION, and NS_TEST_ASSERT_MSG_EQ.

Referenced by CreateReceiverErrorModel().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ProcessedAck()

void TcpFastRetrTest::ProcessedAck ( const Ptr< const TcpSocketState tcb,
const TcpHeader h,
SocketWho  who 
)
protectedvirtual

Processed ack.

Invoked after the processing of the ACK

Parameters
tcbTransmission Control Block
hthe header of segment
whothe socket which has processed the ACK (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 333 of file tcp-fast-retr-test.cc.

References ns3::TcpHeader::GetAckNumber(), ns3::GetCongStateFrom(), ns3::TcpGeneralTest::GetDupAckCount(), ns3::TcpGeneralTest::GetReTxThreshold(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_dupAckReceived, m_pktWasDropped, m_previousAck, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, NS_TEST_ASSERT_MSG_GT_OR_EQ, ns3::TcpGeneralTest::RECEIVER, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ RcvAck()

void TcpFastRetrTest::RcvAck ( const Ptr< const TcpSocketState tcb,
const TcpHeader h,
SocketWho  who 
)
protectedvirtual

Received ack.

Invoked when an ACK is received (no processing is done yet)

Parameters
tcbTransmission Control Block
hthe header of segment
whothe socket which has received the ACK (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 287 of file tcp-fast-retr-test.cc.

References ns3::TcpHeader::GetAckNumber(), ns3::GetCongStateFrom(), ns3::TcpGeneralTest::GetDupAckCount(), ns3::TcpGeneralTest::GetReTxThreshold(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_dupAckReceived, m_seqToKill, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, ns3::TcpGeneralTest::RECEIVER, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ Rx()

void TcpFastRetrTest::Rx ( const Ptr< const Packet p,
const TcpHeader h,
SocketWho  who 
)
protectedvirtual

Packet received from IP layer.

Parameters
ppacket
hheader
whothe socket which has received the packet (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 155 of file tcp-fast-retr-test.cc.

References ns3::TcpGeneralTest::GetSegSize(), ns3::TcpHeader::GetSequenceNumber(), ns3::SequenceNumber< NUMERIC_TYPE, SIGNED_TYPE >::GetValue(), m_bytesRcvButNotAcked, m_pktDropped, m_rcvNextExpAck, m_seqToKill, NS_LOG_INFO, ns3::TcpGeneralTest::RECEIVER, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ Tx()

void TcpFastRetrTest::Tx ( const Ptr< const Packet p,
const TcpHeader h,
SocketWho  who 
)
protectedvirtual

Member Data Documentation

◆ m_bytesRcvButNotAcked

uint32_t TcpFastRetrTest::m_bytesRcvButNotAcked
protected

Number of bytes received but not acked.

Definition at line 94 of file tcp-fast-retr-test.cc.

Referenced by Rx().

◆ m_countRetr

uint32_t TcpFastRetrTest::m_countRetr
protected

Retry counter.

Definition at line 92 of file tcp-fast-retr-test.cc.

Referenced by FinalChecks(), and Tx().

◆ m_dupAckReceived

uint32_t TcpFastRetrTest::m_dupAckReceived
protected

DipACk received.

Definition at line 86 of file tcp-fast-retr-test.cc.

Referenced by ProcessedAck(), and RcvAck().

◆ m_errorModel

Ptr<TcpSeqErrorModel> TcpFastRetrTest::m_errorModel
protected

Error model.

Definition at line 96 of file tcp-fast-retr-test.cc.

Referenced by CreateReceiverErrorModel().

◆ m_pktDropped

bool TcpFastRetrTest::m_pktDropped
protected

The packet has been dropped.

Definition at line 83 of file tcp-fast-retr-test.cc.

Referenced by PktDropped(), Rx(), and Tx().

◆ m_pktWasDropped

bool TcpFastRetrTest::m_pktWasDropped
protected

The packet was dropped (according to the receiver).

Definition at line 84 of file tcp-fast-retr-test.cc.

Referenced by FinalChecks(), and ProcessedAck().

◆ m_previousAck

SequenceNumber32 TcpFastRetrTest::m_previousAck
protected

Previous ACK received.

Definition at line 88 of file tcp-fast-retr-test.cc.

Referenced by ProcessedAck().

◆ m_rcvNextExpAck

SequenceNumber32 TcpFastRetrTest::m_rcvNextExpAck
protected

Receiver next expected sequence number.

Definition at line 90 of file tcp-fast-retr-test.cc.

Referenced by FinalChecks(), PktDropped(), Rx(), and Tx().

◆ m_seqToKill

uint32_t TcpFastRetrTest::m_seqToKill
protected

Sequence number to drop.

Definition at line 85 of file tcp-fast-retr-test.cc.

Referenced by CreateReceiverErrorModel(), PktDropped(), RcvAck(), Rx(), and Tx().

◆ m_sndNextExpSeq

SequenceNumber32 TcpFastRetrTest::m_sndNextExpSeq
protected

Sender next expected sequence number.

Definition at line 89 of file tcp-fast-retr-test.cc.

Referenced by Tx().


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