A Discrete-Event Network Simulator
API
ns3::TcpCloseWithLossTestCase Class Reference

Check if the TCP correctly close the connection after receiving previously lost data. More...

+ Inheritance diagram for ns3::TcpCloseWithLossTestCase:
+ Collaboration diagram for ns3::TcpCloseWithLossTestCase:

Public Member Functions

 TcpCloseWithLossTestCase (bool sackEnabled)
 Constructor. 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 BytesAvailable (uint32_t size, SocketWho who)
 
virtual void ConfigureProperties ()
 Change the configuration of the socket properties. More...
 
Ptr< ErrorModelCreateReceiverErrorModel ()
 Create and return the error model to install in the receiver node. More...
 
void FinalChecks ()
 Performs the (eventual) final checks through test asserts. More...
 
virtual void NormalClose (SocketWho who)
 Socket closed normally. More...
 
void PktDropped (const Ipv4Header &ipH, const TcpHeader &tcpH, Ptr< const Packet > pkt)
 
void Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet received from IP layer. More...
 
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 AfterRTOExpired (const Ptr< const TcpSocketState > tcb, SocketWho who)
 Rto has expired. More...
 
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 void ConfigureEnvironment (void)
 Change the configuration of the environment. More...
 
virtual void CongStateTrace (const TcpSocketState::TcpCongState_t oldValue, const TcpSocketState::TcpCongState_t newValue)
 State on Ack state machine 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< 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...
 
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 PhyDrop (SocketWho who)
 Link drop. More...
 
virtual void ProcessedAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Processed ack. 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 RcvAck (const Ptr< const TcpSocketState > tcb, const TcpHeader &h, SocketWho who)
 Received ack. 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 SetInitialCwnd (SocketWho who, uint32_t initialCwnd)
 Forcefully set the initial cwnd. More...
 
void SetInitialSsThresh (SocketWho who, uint32_t initialSsThresh)
 Forcefully set the initial ssth. 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 use on. 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...
 

Private Attributes

Ptr< TcpSeqErrorModelm_errorModel
 The error model. More...
 
bool m_recvClose
 true when the receiver has closed More...
 
bool m_sackEnabled
 true if sack should be enabled More...
 
bool m_sendClose
 true when the sender has closed More...
 
bool m_synReceived
 true when the receiver gets SYN 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...
 
- Protected Attributes inherited from ns3::TcpGeneralTest
TypeId m_congControlTypeId
 Congestion control. More...
 
TypeId m_recoveryTypeId
 Recovery. More...
 

Detailed Description

Check if the TCP correctly close the connection after receiving previously lost data.

Definition at line 34 of file tcp-close-test.cc.

Constructor & Destructor Documentation

◆ TcpCloseWithLossTestCase()

ns3::TcpCloseWithLossTestCase::TcpCloseWithLossTestCase ( bool  sackEnabled)

Constructor.

Parameters
sackEnabledEnable or disable SACK

Definition at line 70 of file tcp-close-test.cc.

References m_recvClose, m_sackEnabled, m_sendClose, and m_synReceived.

Member Function Documentation

◆ BytesAvailable()

void ns3::TcpCloseWithLossTestCase::BytesAvailable ( uint32_t  size,
SocketWho  who 
)
protectedvirtual

Definition at line 112 of file tcp-close-test.cc.

References ns3::TcpGeneralTest::GetSenderSocket(), m_synReceived, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ ConfigureProperties()

◆ CreateReceiverErrorModel()

Ptr< ErrorModel > ns3::TcpCloseWithLossTestCase::CreateReceiverErrorModel ( )
protectedvirtual

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

Returns
receiver error model

Reimplemented from ns3::TcpGeneralTest.

Definition at line 102 of file tcp-close-test.cc.

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

+ Here is the call graph for this function:

◆ FinalChecks()

void ns3::TcpCloseWithLossTestCase::FinalChecks ( )
protectedvirtual

Performs the (eventual) final checks through test asserts.

Reimplemented from ns3::TcpGeneralTest.

Definition at line 95 of file tcp-close-test.cc.

References m_recvClose, m_sendClose, and NS_TEST_ASSERT_MSG_EQ.

◆ NormalClose()

virtual void ns3::TcpCloseWithLossTestCase::NormalClose ( SocketWho  who)
inlineprotectedvirtual

Socket closed normally.

Parameters
whothe socket closed (SENDER or RECEIVER)

Reimplemented from ns3::TcpGeneralTest.

Definition at line 50 of file tcp-close-test.cc.

References m_recvClose, m_sendClose, and ns3::TcpGeneralTest::SENDER.

◆ PktDropped()

void ns3::TcpCloseWithLossTestCase::PktDropped ( const Ipv4Header ipH,
const TcpHeader tcpH,
Ptr< const Packet pkt 
)
protected

Definition at line 125 of file tcp-close-test.cc.

References NS_LOG_INFO.

Referenced by CreateReceiverErrorModel().

+ Here is the caller graph for this function:

◆ Rx()

void ns3::TcpCloseWithLossTestCase::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 144 of file tcp-close-test.cc.

References ns3::Packet::GetSize(), NS_LOG_INFO, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

◆ Tx()

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

Packet transmitted down to IP layer.

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

Reimplemented from ns3::TcpGeneralTest.

Definition at line 131 of file tcp-close-test.cc.

References ns3::Packet::GetSize(), NS_LOG_INFO, and ns3::TcpGeneralTest::SENDER.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_errorModel

Ptr<TcpSeqErrorModel> ns3::TcpCloseWithLossTestCase::m_errorModel
private

The error model.

Definition at line 63 of file tcp-close-test.cc.

Referenced by CreateReceiverErrorModel().

◆ m_recvClose

bool ns3::TcpCloseWithLossTestCase::m_recvClose
private

true when the receiver has closed

Definition at line 65 of file tcp-close-test.cc.

Referenced by FinalChecks(), NormalClose(), and TcpCloseWithLossTestCase().

◆ m_sackEnabled

bool ns3::TcpCloseWithLossTestCase::m_sackEnabled
private

true if sack should be enabled

Definition at line 67 of file tcp-close-test.cc.

Referenced by ConfigureProperties(), and TcpCloseWithLossTestCase().

◆ m_sendClose

bool ns3::TcpCloseWithLossTestCase::m_sendClose
private

true when the sender has closed

Definition at line 64 of file tcp-close-test.cc.

Referenced by FinalChecks(), NormalClose(), and TcpCloseWithLossTestCase().

◆ m_synReceived

bool ns3::TcpCloseWithLossTestCase::m_synReceived
private

true when the receiver gets SYN

Definition at line 66 of file tcp-close-test.cc.

Referenced by BytesAvailable(), and TcpCloseWithLossTestCase().


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