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

General infrastructure for TCP testing. More...

#include "tcp-general-test.h"

+ Inheritance diagram for ns3::TcpGeneralTest:
+ Collaboration diagram for ns3::TcpGeneralTest:

Public Types

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

Public Member Functions

 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 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 ConfigureProperties (void)
 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 Ptr< SimpleChannelCreateChannel ()
 Create and return the channel installed between the two socket. More...
 
virtual Ptr< ErrorModelCreateReceiverErrorModel ()
 Create and return the error model to install in the receiver node. 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...
 
virtual void FinalChecks ()
 Performs the (eventual) final checks through test asserts. 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 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...
 
virtual void Rx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet received from IP layer. 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 SetEcn (SocketWho who, TcpSocketBase::EcnMode_t ecnMode)
 Forcefully set the ecn mode on. 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...
 
virtual void SsThreshTrace (uint32_t oldValue, uint32_t newValue)
 Slow start threshold changes. More...
 
virtual void Tx (const Ptr< const Packet > p, const TcpHeader &h, SocketWho who)
 Packet transmitted down to IP layer. 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

TypeId m_congControlTypeId
 Congestion control. More...
 
TypeId m_recoveryTypeId
 Recovery. More...
 

Private Member Functions

void AfterRetransmitCb (const Ptr< const TcpSocketState > tcb, const Ptr< const TcpSocketBase > tcp)
 Invoked after a retransmit event. More...
 
void BeforeRetransmitCb (const Ptr< const TcpSocketState > tcb, const Ptr< const TcpSocketBase > tcp)
 Invoked before a retransmit event. More...
 
void DataSentCb (Ptr< Socket > socket, uint32_t size)
 Data sent Callback. More...
 
void ErrorCloseCb (Ptr< Socket > socket)
 Error Close Callback. More...
 
void ForkCb (Ptr< TcpSocketMsgBase > tcp)
 Fork Callback. More...
 
void HandleAccept (Ptr< Socket > socket, const Address &from)
 Handle an accept connection. More...
 
void NormalCloseCb (Ptr< Socket > socket)
 Normal Close Callback. More...
 
void PhyDropCb (std::string context, Ptr< const Packet > p)
 Drop at Phy layer Callback. More...
 
void ProcessedAckCb (Ptr< const Packet > p, const TcpHeader &h, Ptr< const TcpSocketBase > tcp)
 ACK processed Callback. More...
 
void QueueDropCb (std::string context, Ptr< const Packet > p)
 Queue Drop Callback. More...
 
void RcvAckCb (Ptr< const Packet > p, const TcpHeader &h, Ptr< const TcpSocketBase > tcp)
 Receive ACK Callback. More...
 
void RtoExpiredCb (const Ptr< const TcpSocketState > tcb, const Ptr< const TcpSocketBase > tcp)
 RTO expired Callback. More...
 
void RxPacketCb (const Ptr< const Packet > p, const TcpHeader &h, const Ptr< const TcpSocketBase > tcp)
 Rx packet Callback. More...
 
void TxPacketCb (const Ptr< const Packet > p, const TcpHeader &h, const Ptr< const TcpSocketBase > tcp)
 Tx packet Callback. More...
 
void UpdateRttHistoryCb (Ptr< const TcpSocketBase > tcp, const SequenceNumber32 &seq, uint32_t sz, bool isRetransmission)
 Update RTT with new data. More...
 

Private Attributes

Time m_interPacketInterval
 Time between sending application packet down to tcp socket. More...
 
uint32_t m_mtu
 MTU of the environment. More...
 
uint32_t m_pktCount
 Count of the application packet. More...
 
uint32_t m_pktSize
 Size of the application packet. More...
 
Time m_propagationDelay
 Propagation delay of the channel. More...
 
Ptr< TcpSocketMsgBasem_receiverSocket
 Pointer to receiver socket. More...
 
InetSocketAddress m_remoteAddr
 Remote peer address. More...
 
Ptr< TcpSocketMsgBasem_senderSocket
 Pointer to sender socket. More...
 
Time m_startTime
 Data transmission time. More...
 

Detailed Description

General infrastructure for TCP testing.

The class provides a simple setup for a connection testing. Implement or modify the virtual methods in order to install a specified channel, a specified socket and a specified error model on this simulation. Default values are a null error model, and as a channel a SimpleChannel with the propagation delay set through the constructor.

Check DoRun documentation for more information on the environment setup.

Apart from setting up the environment for testing, subclassing permits also to track and check what is happening inside the two connected sockets. Thanks to TcpSocketMsgBase, there are many information provided to children:

  • Tracing of states inside the state machines (TCP and ACK ones, through functions CongStateTrace and TcpStateTrace)
  • cWnd tracing (through CWndTrace)
  • Socket closing: error state, or normal state (NormalClose and ErrorClose)
  • Packet drop, inside queue or over the link (QueueDrop, PhyDrop)
  • Ack received (RcvAck) and Ack processed (ProcessedAck). The first is used to signal that an ACK has been received; after the processing of it, the Second is called
  • A packet is transmitted to IP layer or received from IP layer (Tx and Rx)
  • The RTO expires (RTOExpired)

The default version of such methods is empty; implement their behavior differently, based on what you want to test. Default is empty to avoid the need to implement useless pure virtual function.

If you need values from TcpSocketBase, thanks to the friend relationship between this class and TcpSocketBase itself you can get it. Remember that friendship isn't passed by inheritance, so the way to go is to write a Getters (like GetSegSize) and call it in the subclass.

See also
DoRun
TcpSocketMsgBase

Definition at line 256 of file tcp-general-test.h.

Member Enumeration Documentation

◆ SocketWho

Used as parameter of methods, specifies on what node the caller is interested (e.g.

GetSegSize).

Enumerator
SENDER 

Sender node.

RECEIVER 

Receiver node.

Definition at line 274 of file tcp-general-test.h.

Constructor & Destructor Documentation

◆ TcpGeneralTest()

TcpGeneralTest::TcpGeneralTest ( const std::string &  desc)

TcpGeneralTest constructor.

Please use the method ConfigureEnvironment () to configure other parameters than the test description.

Parameters
descdescription of the test

Definition at line 42 of file tcp-general-test.cc.

References NS_LOG_FUNCTION.

◆ ~TcpGeneralTest()

TcpGeneralTest::~TcpGeneralTest ( )

Definition at line 51 of file tcp-general-test.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AfterRetransmitCb()

void TcpGeneralTest::AfterRetransmitCb ( const Ptr< const TcpSocketState tcb,
const Ptr< const TcpSocketBase tcp 
)
private

Invoked after a retransmit event.

Parameters
tcbTransmission control block.
tcpThe TCP socket.

Definition at line 407 of file tcp-general-test.cc.

References AfterRTOExpired(), ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ AfterRTOExpired()

virtual void ns3::TcpGeneralTest::AfterRTOExpired ( const Ptr< const TcpSocketState tcb,
SocketWho  who 
)
inlineprotectedvirtual

Rto has expired.

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

Reimplemented in TcpTimeRtoTest, TcpSsThreshRtoTest, TcpFastRetrTest, and TcpRtoTest.

Definition at line 904 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by AfterRetransmitCb().

+ Here is the caller graph for this function:

◆ BeforeRetransmitCb()

void TcpGeneralTest::BeforeRetransmitCb ( const Ptr< const TcpSocketState tcb,
const Ptr< const TcpSocketBase tcp 
)
private

Invoked before a retransmit event.

Parameters
tcbTransmission control block.
tcpThe TCP socket.

Definition at line 425 of file tcp-general-test.cc.

References BeforeRTOExpired(), ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ BeforeRTOExpired()

virtual void ns3::TcpGeneralTest::BeforeRTOExpired ( const Ptr< const TcpSocketState tcb,
SocketWho  who 
)
inlineprotectedvirtual

Rto has expired.

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

Reimplemented in TcpSsThreshRtoTest, and TcpBytesInFlightTest.

Definition at line 916 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by BeforeRetransmitCb().

+ Here is the caller graph for this function:

◆ BytesInFlightTrace()

virtual void ns3::TcpGeneralTest::BytesInFlightTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
inlineprotectedvirtual

Bytes in flight changes.

This applies only for sender socket.

Parameters
oldValueold value
newValuenew value

Reimplemented in TcpRateLinuxWithSocketsTest, TcpSsThreshRtoTest, and TcpBytesInFlightTest.

Definition at line 742 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ ConfigureEnvironment()

◆ ConfigureProperties()

void TcpGeneralTest::ConfigureProperties ( void  )
protectedvirtual

Change the configuration of the socket properties.

Reimplemented in TcpNewRenoCongAvoidNormalTest, TcpFastRetrTest, TcpSlowStartNormalTest, ns3::TcpEcnTest, TcpRtoTest, TcpZeroWindowTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 115 of file tcp-general-test.cc.

References NS_LOG_FUNCTION, RECEIVER, SENDER, SetInitialCwnd(), SetInitialSsThresh(), and SetSegmentSize().

Referenced by ns3::TcpCloseWithLossTestCase::ConfigureProperties(), ns3::TcpEcnTest::ConfigureProperties(), and DoRun().

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

◆ CongStateTrace()

virtual void ns3::TcpGeneralTest::CongStateTrace ( const TcpSocketState::TcpCongState_t  oldValue,
const TcpSocketState::TcpCongState_t  newValue 
)
inlineprotectedvirtual

State on Ack state machine changes.

Parameters
oldValueold value
newValuenew value

Reimplemented in TcpFastRetrTest.

Definition at line 675 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ CreateChannel()

Ptr< SimpleChannel > TcpGeneralTest::CreateChannel ( )
protectedvirtual

Create and return the channel installed between the two socket.

Returns
A SimpleChannel subclass

Definition at line 268 of file tcp-general-test.cc.

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

Referenced by DoRun().

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

◆ CreateReceiverErrorModel()

Ptr< ErrorModel > TcpGeneralTest::CreateReceiverErrorModel ( )
protectedvirtual

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

Returns
receiver error model

Reimplemented in TcpAdvWindowOnLossTest, TcpTimeRtoTest, TcpAdvertisedWindowTest, TcpRateLinuxWithSocketsTest, TcpRttEstimationWithLossTest, TcpSsThreshRtoTest, TcpBytesInFlightTest, TcpFastRetrTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 318 of file tcp-general-test.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ CreateReceiverSocket()

Ptr< TcpSocketMsgBase > TcpGeneralTest::CreateReceiverSocket ( Ptr< Node node)
protectedvirtual

Create and install the socket to install on the receiver.

Parameters
nodereceiver node pointer
Returns
the socket to be installed in the receiver

Reimplemented in TcpAdvWindowOnLossTest, TcpAdvertisedWindowTest, TcpSlowStartAttackerTest, TcpDataSentCbTestCase, WScalingTestCase, TimestampTestCase, SackPermittedTestCase, TcpRttEstimationTest, and TcpZeroWindowTest.

Definition at line 330 of file tcp-general-test.cc.

References CreateSocket(), ns3::TcpSocketMsgBase::GetTypeId(), m_congControlTypeId, and m_recoveryTypeId.

Referenced by DoRun().

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

◆ CreateSenderErrorModel()

Ptr< ErrorModel > TcpGeneralTest::CreateSenderErrorModel ( )
protectedvirtual

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

Returns
sender error model

Reimplemented in TcpFastRetrTest.

Definition at line 312 of file tcp-general-test.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ CreateSenderSocket()

Ptr< TcpSocketMsgBase > TcpGeneralTest::CreateSenderSocket ( Ptr< Node node)
protectedvirtual

Create and install the socket to install on the sender.

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

Reimplemented in TcpAdvWindowOnLossTest, TcpTimeRtoTest, TcpRateLinuxWithSocketsTest, TcpSsThreshRtoTest, ns3::TcpEcnTest, WScalingTestCase, TcpPktsAckedOpenTest, TimestampTestCase, TcpRtoTest, SackPermittedTestCase, TcpFastRetrTest, and TcpRttEstimationTest.

Definition at line 324 of file tcp-general-test.cc.

References CreateSocket(), ns3::TcpSocketMsgBase::GetTypeId(), m_congControlTypeId, and m_recoveryTypeId.

Referenced by ns3::TcpEcnTest::CreateSenderSocket(), and DoRun().

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

◆ CreateSocket() [1/2]

Ptr< TcpSocketMsgBase > TcpGeneralTest::CreateSocket ( Ptr< Node node,
TypeId  socketType,
TypeId  congControl 
)
protectedvirtual

Create a socket.

Parameters
nodeassociated node
socketTypeType of the TCP socket
congControlcongestion control
Returns
a pointer to the newer created socket

Definition at line 278 of file tcp-general-test.cc.

References m_recoveryTypeId.

Referenced by TcpSlowStartAttackerTest::CreateReceiverSocket(), TcpAdvertisedWindowTest::CreateReceiverSocket(), CreateReceiverSocket(), TcpAdvWindowOnLossTest::CreateReceiverSocket(), ns3::TcpEcnTest::CreateSenderSocket(), and CreateSenderSocket().

+ Here is the caller graph for this function:

◆ CreateSocket() [2/2]

Ptr< TcpSocketMsgBase > TcpGeneralTest::CreateSocket ( Ptr< Node node,
TypeId  socketType,
TypeId  congControl,
TypeId  recoveryAlgorithm 
)
protectedvirtual

Create a socket.

Parameters
nodeassociated node
socketTypeType of the TCP socket
congControlcongestion control
recoveryAlgorithmrecovery algorithm
Returns
a pointer to the newer created socket

Definition at line 285 of file tcp-general-test.cc.

References ns3::ObjectFactory::Create(), ns3::Object::GetObject(), ns3::RttMeanDeviation::GetTypeId(), and ns3::ObjectFactory::SetTypeId().

+ Here is the call graph for this function:

◆ CWndInflTrace()

virtual void ns3::TcpGeneralTest::CWndInflTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
inlineprotectedvirtual

Tracks the inflated congestion window changes.

Parameters
oldValueold value
newValuenew value

Definition at line 700 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ CWndTrace()

virtual void ns3::TcpGeneralTest::CWndTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
inlineprotectedvirtual

Tracks the congestion window changes.

Parameters
oldValueold value
newValuenew value

Reimplemented in TcpNewRenoCongAvoidNormalTest, ns3::TcpEcnTest, and TcpSlowStartNormalTest.

Definition at line 688 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ DataSent()

virtual void ns3::TcpGeneralTest::DataSent ( uint32_t  size,
SocketWho  who 
)
inlineprotectedvirtual

Notifying application for sent data.

Parameters
sizethe amount of bytes transmitted
whowhere the RTO has expired (SENDER or RECEIVER)

Reimplemented in TcpDataSentCbTestCase.

Definition at line 944 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DataSentCb().

+ Here is the caller graph for this function:

◆ DataSentCb()

void TcpGeneralTest::DataSentCb ( Ptr< Socket socket,
uint32_t  size 
)
private

Data sent Callback.

Parameters
socketThe socket.
sizeThe data size.

Definition at line 443 of file tcp-general-test.cc.

References DataSent(), ns3::Socket::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ DoConnect()

void TcpGeneralTest::DoConnect ( void  )
protected

Scheduled at 0.0, SENDER starts the connection to RECEIVER.

Definition at line 251 of file tcp-general-test.cc.

References m_remoteAddr, m_senderSocket, and NS_LOG_INFO.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ DoRun()

void TcpGeneralTest::DoRun ( void  )
protectedvirtual

Execute the tcp test.

As environment, two socket are connected through a SimpleChannel. Each device has an MTU of 1500 bytes, and the application starts to send packet at 10s of simulated time, through SendPacket.

If you need to change parameters of the environment, please inherit an implement the method ConfigureEnvironment (); that will be called at the beginning of this method. To configure Socket parameters (i.e. parameters that should be applied after socket have been created) use ConfigureProperties.

Please do not use any Config:: statements.

See also
ConfigureEnvironment

Implements ns3::TestCase.

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

References AfterRetransmitCb(), ns3::Ipv4AddressHelper::Assign(), BeforeRetransmitCb(), BytesInFlightTrace(), third::channel, ConfigureEnvironment(), ConfigureProperties(), CongStateTrace(), CreateChannel(), CreateReceiverErrorModel(), CreateReceiverSocket(), CreateSenderErrorModel(), CreateSenderSocket(), CWndInflTrace(), CWndTrace(), DataSentCb(), DoConnect(), ns3::Packet::EnablePrinting(), ErrorCloseCb(), ForkCb(), ns3::NetDeviceContainer::Get(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::Ipv4Address::GetAny(), ns3::SimpleNetDevice::GetQueue(), HandleAccept(), HighestTxSeqTrace(), ns3::SimpleNetDeviceHelper::Install(), ns3::InternetStackHelper::Install(), m_interPacketInterval, m_mtu, m_pktCount, m_pktSize, m_receiverSocket, m_remoteAddr, m_senderSocket, m_startTime, ns3::MakeCallback(), ns3::MakeNullCallback(), NextTxSeqTrace(), first::nodes, NormalCloseCb(), NS_LOG_INFO, PhyDropCb(), ProcessedAckCb(), QueueDropCb(), RateSampleUpdatedTrace(), RateUpdatedTrace(), RcvAckCb(), ReceivePacket(), RtoTrace(), RttTrace(), ns3::Simulator::Run(), RxPacketCb(), ns3::Simulator::Schedule(), ns3::Simulator::ScheduleWithContext(), ns3::Seconds(), SendPacket(), ns3::Ipv4AddressHelper::SetBase(), ns3::SimpleNetDevice::SetMtu(), ns3::SimpleNetDeviceHelper::SetNetDevicePointToPointMode(), ns3::SimpleNetDevice::SetReceiveErrorModel(), SsThreshTrace(), ns3::ObjectBase::TraceConnect(), TxPacketCb(), and UpdateRttHistoryCb().

◆ DoTeardown()

void TcpGeneralTest::DoTeardown ( void  )
protectedvirtual

Teardown the TCP test.

Reimplemented from ns3::TestCase.

Definition at line 91 of file tcp-general-test.cc.

References ns3::Simulator::Destroy(), FinalChecks(), and NS_LOG_INFO.

+ Here is the call graph for this function:

◆ ErrorClose()

virtual void ns3::TcpGeneralTest::ErrorClose ( SocketWho  who)
inlineprotectedvirtual

Socket closed with an error.

Parameters
whothe socket closed (SENDER or RECEIVER)
Todo:
indicate the error

Reimplemented in TcpTimeRtoTest.

Definition at line 822 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by ErrorCloseCb().

+ Here is the caller graph for this function:

◆ ErrorCloseCb()

void TcpGeneralTest::ErrorCloseCb ( Ptr< Socket socket)
private

Error Close Callback.

Parameters
socketThe socket.

Definition at line 460 of file tcp-general-test.cc.

References ErrorClose(), ns3::Socket::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by DoRun(), and HandleAccept().

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

◆ FinalChecks()

virtual void ns3::TcpGeneralTest::FinalChecks ( )
inlineprotectedvirtual

Performs the (eventual) final checks through test asserts.

Reimplemented in TcpTimeRtoTest, TcpRateLinuxWithSocketsTest, TcpDataSentCbTestCase, TcpBytesInFlightTest, TcpFastRetrTest, TcpPktsAckedOpenTest, TcpRtoTest, TcpRttEstimationTest, TcpZeroWindowTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 953 of file tcp-general-test.h.

Referenced by DoTeardown().

+ Here is the caller graph for this function:

◆ ForkCb()

void TcpGeneralTest::ForkCb ( Ptr< TcpSocketMsgBase tcp)
private

Fork Callback.

Parameters
tcpThe TCP socket.

Definition at line 561 of file tcp-general-test.cc.

References m_receiverSocket, and NS_LOG_FUNCTION.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ GetClockGranularity()

Time TcpGeneralTest::GetClockGranularity ( SocketWho  who)
protected

Get the clock granularity attribute.

Parameters
whonode to get the parameter from
Returns
clock granularity

Definition at line 762 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpTimeRtoTest::Tx().

+ Here is the caller graph for this function:

◆ GetConnTimeout()

Time TcpGeneralTest::GetConnTimeout ( SocketWho  who)
protected

Get the retransmission time for the SYN segments.

Parameters
whonode to get the parameter from
Returns
SYN segments RTO time

Definition at line 728 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpTimeRtoTest::Tx().

+ Here is the caller graph for this function:

◆ GetDelAckCount()

uint32_t TcpGeneralTest::GetDelAckCount ( SocketWho  who)
protected

Get the number of delayed ack (if present)

Parameters
whonode to get the parameter from
Returns
number of ack we will wait before sending an ACK

Definition at line 603 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpFastRetrTest::Tx().

+ Here is the caller graph for this function:

◆ GetDelAckTimeout()

Time TcpGeneralTest::GetDelAckTimeout ( SocketWho  who)
protected

Get the timeout of delayed ack (if present)

Parameters
whonode to get the parameter from
Returns
time we will wait before sending an ACK

Definition at line 620 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ GetDupAckCount()

uint32_t TcpGeneralTest::GetDupAckCount ( SocketWho  who)
protected

Get the number of dupack received.

Parameters
whonode to get the parameter from
Returns
number of dupack

Definition at line 586 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpFastRetrTest::CongStateTrace(), TcpFastRetrTest::ProcessedAck(), and TcpFastRetrTest::RcvAck().

+ Here is the caller graph for this function:

◆ GetHighestTxMark()

SequenceNumber32 TcpGeneralTest::GetHighestTxMark ( SocketWho  who)
protected

Get the highest tx mark of the node specified.

Parameters
whonode to get the parameter from
Returns
mark of the specified node

Definition at line 654 of file tcp-general-test.cc.

References GetTcb(), and ns3::TcpSocketState::m_highTxMark.

+ Here is the call graph for this function:

◆ GetInitialCwnd()

uint32_t TcpGeneralTest::GetInitialCwnd ( SocketWho  who)
protected

Get the initial congestion window.

Parameters
whonode to get the parameter from
Returns
initial cwnd

Definition at line 660 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ GetInitialSsThresh()

uint32_t TcpGeneralTest::GetInitialSsThresh ( SocketWho  who)
protected

Get the initial slow start threshold.

Parameters
whonode to get the parameter from
Returns
initial slow start threshold

Definition at line 677 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpSlowStartNormalTest::CWndTrace().

+ Here is the caller graph for this function:

◆ GetMinRto()

Time TcpGeneralTest::GetMinRto ( SocketWho  who)
protected

Get the minimum RTO attribute.

Parameters
whonode to get the parameter from
Returns
minimum RTO time

Definition at line 711 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpTimeRtoTest::Tx().

+ Here is the caller graph for this function:

◆ GetMtu()

uint32_t ns3::TcpGeneralTest::GetMtu ( void  ) const
inlineprotected

Get the MTU of the environment.

Returns
MTU of the environment

Definition at line 979 of file tcp-general-test.h.

References m_mtu.

◆ GetPersistentEvent()

EventId TcpGeneralTest::GetPersistentEvent ( SocketWho  who)
protected

Get the persistent event of the selected socket.

Parameters
whosocket where check the parameter
Returns
the persistent event in the selected socket

Definition at line 815 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpZeroWindowTest::ProcessedAck().

+ Here is the caller graph for this function:

◆ GetPersistentTimeout()

Time TcpGeneralTest::GetPersistentTimeout ( SocketWho  who)
protected

Get the persistent timeout of the selected socket.

Parameters
whosocket where check the parameter
Returns
the persistent timeout in the selected socket

Definition at line 833 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ GetPktCount()

uint32_t ns3::TcpGeneralTest::GetPktCount ( ) const
inlineprotected

Get the number of application packets.

Returns
count of application packets to be generated

Definition at line 997 of file tcp-general-test.h.

References m_pktCount.

◆ GetPktInterval()

Time ns3::TcpGeneralTest::GetPktInterval ( ) const
inlineprotected

Get the interval to wait for each packet sent down from application to TCP.

Returns
interval between packet

Definition at line 1007 of file tcp-general-test.h.

References m_interPacketInterval.

◆ GetPktSize()

uint32_t ns3::TcpGeneralTest::GetPktSize ( ) const
inlineprotected

Get the application packet size.

Returns
application packet size

Definition at line 988 of file tcp-general-test.h.

References m_pktSize.

◆ GetPropagationDelay()

Time ns3::TcpGeneralTest::GetPropagationDelay ( ) const
inlineprotected

Get the channel Propagation Delay.

Returns
propagation delay of the channel

Definition at line 961 of file tcp-general-test.h.

References m_propagationDelay.

◆ GetReceiverSocket()

Ptr<TcpSocketMsgBase> ns3::TcpGeneralTest::GetReceiverSocket ( )
inlineprotected

Get the pointer to a previously created receiver socket.

Returns
ptr to receiver socket or 0

Definition at line 352 of file tcp-general-test.h.

References m_receiverSocket.

Referenced by ns3::TcpCloseWithLossTestCase::ConfigureProperties().

+ Here is the caller graph for this function:

◆ GetReTxThreshold()

uint32_t TcpGeneralTest::GetReTxThreshold ( SocketWho  who)
protected

Get the retransmission threshold.

Parameters
whonode to get the parameter from
Returns
retransmission threshold

Definition at line 569 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpFastRetrTest::CongStateTrace(), TcpFastRetrTest::ProcessedAck(), and TcpFastRetrTest::RcvAck().

+ Here is the caller graph for this function:

◆ GetRto()

Time TcpGeneralTest::GetRto ( SocketWho  who)
protected

Get the retransmission time.

Parameters
whonode to get the parameter from
Returns
calculated RTO time

Definition at line 694 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpTimeRtoTest::AfterRTOExpired(), and TcpTimeRtoTest::Tx().

+ Here is the caller graph for this function:

◆ GetRttEstimator()

Ptr< RttEstimator > TcpGeneralTest::GetRttEstimator ( SocketWho  who)
protected

Get the Rtt estimator of the socket.

Parameters
whonode to get the parameter from
Returns
Rtt estimator

Definition at line 745 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpRttEstimationTest::Tx(), and TcpTimeRtoTest::Tx().

+ Here is the caller graph for this function:

◆ GetRWnd()

uint32_t TcpGeneralTest::GetRWnd ( SocketWho  who)
protected

Get the rWnd of the selected socket.

Parameters
whosocket where check the parameter
Returns
the received advertised window

Definition at line 797 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ GetRxBuffer()

Ptr< TcpRxBuffer > TcpGeneralTest::GetRxBuffer ( SocketWho  who)
protected

Get the Rx buffer from selected socket.

Parameters
whosocket where get the TCB
Returns
the rx buffer

Definition at line 869 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by WScalingTestCase::Tx().

+ Here is the caller graph for this function:

◆ GetSegSize()

uint32_t TcpGeneralTest::GetSegSize ( SocketWho  who)
protected

Get the segment size of the node specified.

Parameters
whonode to get the parameter from
Returns
segment size of the specified node

Definition at line 637 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpNewRenoCongAvoidNormalTest::Check(), TcpSlowStartNormalTest::CWndTrace(), TcpPktsAckedOpenTest::FinalChecks(), TcpBytesInFlightTest::Rx(), TcpSlowStartNormalTest::Rx(), TcpFastRetrTest::Rx(), TcpFastRetrTest::Tx(), and TcpSlowStartNormalTest::Tx().

+ Here is the caller graph for this function:

◆ GetSenderSocket()

Ptr<TcpSocketMsgBase> ns3::TcpGeneralTest::GetSenderSocket ( )
inlineprotected

Get the pointer to a previously created sender socket.

Returns
ptr to sender socket or 0

Definition at line 343 of file tcp-general-test.h.

References m_senderSocket.

Referenced by TcpSsThreshRtoTest::AfterRTOExpired(), TcpBytesInFlightTest::BeforeRTOExpired(), ns3::TcpCloseWithLossTestCase::BytesAvailable(), and ns3::TcpCloseWithLossTestCase::ConfigureProperties().

+ Here is the caller graph for this function:

◆ GetStartTime()

Time ns3::TcpGeneralTest::GetStartTime ( ) const
inlineprotected

Get the data start time.

Returns
start time of data packets

Definition at line 970 of file tcp-general-test.h.

References m_startTime.

◆ GetTcb()

Ptr< TcpSocketState > TcpGeneralTest::GetTcb ( SocketWho  who)
protected

Get the TCB from selected socket.

Parameters
whosocket where get the TCB
Returns
the transmission control block

Definition at line 851 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by GetHighestTxMark(), and TcpZeroWindowTest::Tx().

+ Here is the caller graph for this function:

◆ GetTcpState()

TcpSocket::TcpStates_t TcpGeneralTest::GetTcpState ( SocketWho  who)
protected

Get the state of the TCP state machine.

Parameters
whosocket where check the parameter
Returns
the state of the socket

Definition at line 779 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ GetTxBuffer()

Ptr< TcpTxBuffer > TcpGeneralTest::GetTxBuffer ( SocketWho  who)
protected

Get the Tx buffer from selected socket.

Parameters
whosocket where get the TCB
Returns
the tx buffer

Definition at line 887 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

◆ HandleAccept()

void TcpGeneralTest::HandleAccept ( Ptr< Socket socket,
const Address from 
)
private

Handle an accept connection.

Parameters
socketThe socket.
fromThe sender.

Definition at line 258 of file tcp-general-test.cc.

References ErrorCloseCb(), ns3::MakeCallback(), NormalCloseCb(), ReceivePacket(), ns3::Socket::SetCloseCallbacks(), and ns3::Socket::SetRecvCallback().

Referenced by DoRun().

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

◆ HighestTxSeqTrace()

virtual void ns3::TcpGeneralTest::HighestTxSeqTrace ( SequenceNumber32  oldValue,
SequenceNumber32  newValue 
)
inlineprotectedvirtual

Highest tx seq changes.

This applies only for sender socket.

Parameters
oldValueold value
newValuenew value

Definition at line 784 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ NextTxSeqTrace()

virtual void ns3::TcpGeneralTest::NextTxSeqTrace ( SequenceNumber32  oldValue,
SequenceNumber32  newValue 
)
inlineprotectedvirtual

Next tx seq changes.

This applies only for sender socket.

Parameters
oldValueold value
newValuenew value

Definition at line 770 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ NormalClose()

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

Socket closed normally.

Parameters
whothe socket closed (SENDER or RECEIVER)

Reimplemented in TcpNewRenoCongAvoidNormalTest, TcpZeroWindowTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 812 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by NormalCloseCb().

+ Here is the caller graph for this function:

◆ NormalCloseCb()

void TcpGeneralTest::NormalCloseCb ( Ptr< Socket socket)
private

Normal Close Callback.

Parameters
socketThe socket.

Definition at line 371 of file tcp-general-test.cc.

References ns3::Socket::GetNode(), m_receiverSocket, m_senderSocket, NormalClose(), NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by DoRun(), and HandleAccept().

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

◆ PhyDrop()

virtual void ns3::TcpGeneralTest::PhyDrop ( SocketWho  who)
inlineprotectedvirtual

Link drop.

Parameters
whowhere the drop occurred (SENDER or RECEIVER)

Reimplemented in TcpNewRenoCongAvoidNormalTest, and TcpSlowStartNormalTest.

Definition at line 841 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by PhyDropCb().

+ Here is the caller graph for this function:

◆ PhyDropCb()

void TcpGeneralTest::PhyDropCb ( std::string  context,
Ptr< const Packet p 
)
private

Drop at Phy layer Callback.

Parameters
contextThe context.
pThe packet.

Definition at line 353 of file tcp-general-test.cc.

References NS_FATAL_ERROR, NS_UNUSED, PhyDrop(), RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ ProcessedAck()

virtual void ns3::TcpGeneralTest::ProcessedAck ( const Ptr< const TcpSocketState tcb,
const TcpHeader h,
SocketWho  who 
)
inlineprotectedvirtual

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 in TcpRtoTest, TcpFastRetrTest, and TcpZeroWindowTest.

Definition at line 872 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by ProcessedAckCb().

+ Here is the caller graph for this function:

◆ ProcessedAckCb()

void TcpGeneralTest::ProcessedAckCb ( Ptr< const Packet p,
const TcpHeader h,
Ptr< const TcpSocketBase tcp 
)
private

ACK processed Callback.

Parameters
pThe packet.
hTCP header.
tcpThe TCP socket.

Definition at line 543 of file tcp-general-test.cc.

References ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, ns3::TcpSocketBase::m_tcb, NS_FATAL_ERROR, ProcessedAck(), RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ QueueDrop()

virtual void ns3::TcpGeneralTest::QueueDrop ( SocketWho  who)
inlineprotectedvirtual

Drop on the queue.

Parameters
whowhere the drop occurred (SENDER or RECEIVER)

Reimplemented in TcpNewRenoCongAvoidNormalTest, and TcpSlowStartNormalTest.

Definition at line 832 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by QueueDropCb().

+ Here is the caller graph for this function:

◆ QueueDropCb()

void TcpGeneralTest::QueueDropCb ( std::string  context,
Ptr< const Packet p 
)
private

Queue Drop Callback.

Parameters
contextThe context.
pThe packet.

Definition at line 336 of file tcp-general-test.cc.

References NS_FATAL_ERROR, QueueDrop(), RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ RateSampleUpdatedTrace()

virtual void ns3::TcpGeneralTest::RateSampleUpdatedTrace ( const TcpRateLinux::TcpRateSample sample)
inlineprotectedvirtual

Track the rate sample value of TcpRateLinux.

Parameters
sampleupdated value of TcpRateSample.

Definition at line 803 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ RateUpdatedTrace()

virtual void ns3::TcpGeneralTest::RateUpdatedTrace ( const TcpRateLinux::TcpRateConnection rate)
inlineprotectedvirtual

Track the rate value of TcpRateLinux.

Parameters
rateupdated value of TcpRate.

Definition at line 794 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ RcvAck()

virtual void ns3::TcpGeneralTest::RcvAck ( const Ptr< const TcpSocketState tcb,
const TcpHeader h,
SocketWho  who 
)
inlineprotectedvirtual

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 in TcpRtoTest, and TcpFastRetrTest.

Definition at line 855 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by RcvAckCb().

+ Here is the caller graph for this function:

◆ RcvAckCb()

void TcpGeneralTest::RcvAckCb ( Ptr< const Packet p,
const TcpHeader h,
Ptr< const TcpSocketBase tcp 
)
private

Receive ACK Callback.

Parameters
pThe packet.
hTCP header.
tcpThe TCP socket.

Definition at line 489 of file tcp-general-test.cc.

References ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, ns3::TcpSocketBase::m_tcb, NS_FATAL_ERROR, RcvAck(), RECEIVER, and SENDER.

Referenced by DoRun().

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

◆ ReceivePacket()

void TcpGeneralTest::ReceivePacket ( Ptr< Socket socket)
protectedvirtual

Packet received.

The method processes the packet (application-layer)

Parameters
socketsocket which has received the packet

Definition at line 57 of file tcp-general-test.cc.

References ns3::Packet::GetSize(), NS_LOG_FUNCTION, and ns3::Socket::RecvFrom().

Referenced by DoRun(), and HandleAccept().

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

◆ RtoExpiredCb()

void ns3::TcpGeneralTest::RtoExpiredCb ( const Ptr< const TcpSocketState tcb,
const Ptr< const TcpSocketBase tcp 
)
private

RTO expired Callback.

Parameters
tcbTransmission control block.
tcpThe TCP socket.

◆ RtoTrace()

virtual void ns3::TcpGeneralTest::RtoTrace ( Time  oldValue,
Time  newValue 
)
inlineprotectedvirtual

RTO changes.

This applies only for sender socket.

Parameters
oldValueold value
newValuenew value

Definition at line 756 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ RttTrace()

virtual void ns3::TcpGeneralTest::RttTrace ( Time  oldTime,
Time  newTime 
)
inlineprotectedvirtual

Rtt changes.

This applies only for sender socket.

Parameters
oldTimeold value
newTimenew value

Reimplemented in TcpRttEstimationTest.

Definition at line 714 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ Rx()

void TcpGeneralTest::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 in TcpRateLinuxWithSocketsTest, TcpFastRetrTest, TcpSlowStartNormalTest, ns3::TcpEcnTest, TcpBytesInFlightTest, TcpPktsAckedOpenTest, TimestampTestCase, TcpRttEstimationTest, TcpZeroWindowTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 483 of file tcp-general-test.cc.

References NS_LOG_FUNCTION.

Referenced by RxPacketCb().

+ Here is the caller graph for this function:

◆ RxPacketCb()

void TcpGeneralTest::RxPacketCb ( const Ptr< const Packet p,
const TcpHeader h,
const Ptr< const TcpSocketBase tcp 
)
private

Rx packet Callback.

Parameters
pThe packet.
hTCP header.
tcpThe TCP socket.

Definition at line 525 of file tcp-general-test.cc.

References ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, Rx(), and SENDER.

Referenced by DoRun().

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

◆ SendPacket()

void TcpGeneralTest::SendPacket ( Ptr< Socket socket,
uint32_t  pktSize,
uint32_t  pktCount,
Time  pktInterval 
)
protected

Send packets to other endpoint.

Parameters
socketSocket
pktSizesize of the packet
pktCountnumber of packets to send
pktIntervalinterval between packet (application-level)

Definition at line 73 of file tcp-general-test.cc.

References ns3::Socket::Close(), ns3::Time::GetSeconds(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Socket::Send().

Referenced by DoRun().

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

◆ SetAppPktCount()

◆ SetAppPktInterval()

void ns3::TcpGeneralTest::SetAppPktInterval ( Time  pktInterval)
inlineprotected

Interval between app-generated packet.

Parameters
pktIntervalinterval

Definition at line 633 of file tcp-general-test.h.

References m_interPacketInterval.

Referenced by TcpSsThreshRtoTest::ConfigureEnvironment(), ConfigureEnvironment(), and ns3::TcpCloseWithLossTestCase::ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetAppPktSize()

void ns3::TcpGeneralTest::SetAppPktSize ( uint32_t  pktSize)
inlineprotected

Set app packet size.

The application will generate packet of this size.

Parameters
pktSizesize of the packet

Definition at line 617 of file tcp-general-test.h.

References m_pktSize.

Referenced by TcpSlowStartNormalTest::ConfigureEnvironment(), TcpNewRenoCongAvoidNormalTest::ConfigureEnvironment(), TcpAdvertisedWindowTest::ConfigureEnvironment(), TcpAdvWindowOnLossTest::ConfigureEnvironment(), ConfigureEnvironment(), and ns3::TcpCloseWithLossTestCase::ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetCongestionControl()

void ns3::TcpGeneralTest::SetCongestionControl ( TypeId  congControl)
inlineprotected

Congestion control of the sender socket.

Parameters
congControltypeid of the congestion control algorithm

Definition at line 654 of file tcp-general-test.h.

References m_congControlTypeId.

Referenced by ConfigureEnvironment().

+ Here is the caller graph for this function:

◆ SetEcn()

void TcpGeneralTest::SetEcn ( SocketWho  who,
TcpSocketBase::EcnMode_t  ecnMode 
)
protected

Forcefully set the ecn mode on.

Parameters
whosocket to force
ecnModeMode of ECN. Currently NoEcn and ClassicEcn is supported.

Definition at line 955 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by ns3::TcpEcnTest::ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetInitialCwnd()

void TcpGeneralTest::SetInitialCwnd ( SocketWho  who,
uint32_t  initialCwnd 
)
protected

Forcefully set the initial cwnd.

Parameters
whosocket to force
initialCwndsize of the initial cwnd

Definition at line 939 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by ns3::TcpCloseWithLossTestCase::ConfigureProperties(), TcpZeroWindowTest::ConfigureProperties(), and ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetInitialSsThresh()

void TcpGeneralTest::SetInitialSsThresh ( SocketWho  who,
uint32_t  initialSsThresh 
)
protected

Forcefully set the initial ssth.

Parameters
whosocket to force
initialSsThreshsize of the initial ssth

Definition at line 972 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpRtoTest::ConfigureProperties(), TcpSlowStartNormalTest::ConfigureProperties(), TcpFastRetrTest::ConfigureProperties(), TcpNewRenoCongAvoidNormalTest::ConfigureProperties(), and ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetMTU()

void ns3::TcpGeneralTest::SetMTU ( uint32_t  mtu)
inlineprotected

◆ SetPropagationDelay()

void ns3::TcpGeneralTest::SetPropagationDelay ( Time  propDelay)
inlineprotected

◆ SetRcvBufSize()

void TcpGeneralTest::SetRcvBufSize ( SocketWho  who,
uint32_t  size 
)
protected

Forcefully set a defined size for rx buffer.

Parameters
whosocket to force
sizesize of the rx buffer

Definition at line 905 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by TcpZeroWindowTest::IncreaseBufSize().

+ Here is the caller graph for this function:

◆ SetRecoveryAlgorithm()

void ns3::TcpGeneralTest::SetRecoveryAlgorithm ( TypeId  reccovery)
inlineprotected

recovery algorithm of the sender socket

Parameters
recoverytypeid of the recovery algorithm

Definition at line 661 of file tcp-general-test.h.

References m_recoveryTypeId.

Referenced by ConfigureEnvironment().

+ Here is the caller graph for this function:

◆ SetSegmentSize()

void TcpGeneralTest::SetSegmentSize ( SocketWho  who,
uint32_t  segmentSize 
)
protected

Forcefully set the segment size.

Parameters
whosocket to force
segmentSizesegmentSize

Definition at line 922 of file tcp-general-test.cc.

References m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, and SENDER.

Referenced by ns3::TcpCloseWithLossTestCase::ConfigureProperties(), TcpSlowStartNormalTest::ConfigureProperties(), TcpNewRenoCongAvoidNormalTest::ConfigureProperties(), and ConfigureProperties().

+ Here is the caller graph for this function:

◆ SetTransmitStart()

void ns3::TcpGeneralTest::SetTransmitStart ( Time  startTime)
inlineprotected

Set the initial time at which the application sends the first data packet.

Parameters
startTimestart time

Definition at line 647 of file tcp-general-test.h.

References m_startTime, and startTime.

Referenced by TcpZeroWindowTest::ConfigureEnvironment(), TcpRttEstimationTest::ConfigureEnvironment(), TcpBytesInFlightTest::ConfigureEnvironment(), TcpRateLinuxWithSocketsTest::ConfigureEnvironment(), TcpAdvertisedWindowTest::ConfigureEnvironment(), TcpAdvWindowOnLossTest::ConfigureEnvironment(), and ConfigureEnvironment().

+ Here is the caller graph for this function:

◆ SsThreshTrace()

virtual void ns3::TcpGeneralTest::SsThreshTrace ( uint32_t  oldValue,
uint32_t  newValue 
)
inlineprotectedvirtual

Slow start threshold changes.

This applies only for sender socket.

Parameters
oldValueold value
newValuenew value

Reimplemented in TcpSsThreshRtoTest.

Definition at line 728 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ Tx()

void TcpGeneralTest::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 in TcpTimeRtoTest, TcpBytesInFlightTest, WScalingTestCase, ns3::TcpEcnTest, TcpFastRetrTest, TcpSlowStartNormalTest, TimestampTestCase, SackPermittedTestCase, TcpRttEstimationTest, TcpZeroWindowTest, and ns3::TcpCloseWithLossTestCase.

Definition at line 477 of file tcp-general-test.cc.

References NS_LOG_FUNCTION.

Referenced by TxPacketCb().

+ Here is the caller graph for this function:

◆ TxPacketCb()

void TcpGeneralTest::TxPacketCb ( const Ptr< const Packet p,
const TcpHeader h,
const Ptr< const TcpSocketBase tcp 
)
private

Tx packet Callback.

Parameters
pThe packet.
hTCP header.
tcpThe TCP socket.

Definition at line 507 of file tcp-general-test.cc.

References ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, SENDER, and Tx().

Referenced by DoRun().

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

◆ UpdatedRttHistory()

virtual void ns3::TcpGeneralTest::UpdatedRttHistory ( const SequenceNumber32 seq,
uint32_t  sz,
bool  isRetransmission,
SocketWho  who 
)
inlineprotectedvirtual

Updated the Rtt history.

Parameters
seqSequence inserted
szsize
isRetransmissionself-explanatory
whowhere the rtt history was updated

Reimplemented in TcpRttEstimationTest.

Definition at line 929 of file tcp-general-test.h.

References NS_UNUSED.

Referenced by UpdateRttHistoryCb().

+ Here is the caller graph for this function:

◆ UpdateRttHistoryCb()

void TcpGeneralTest::UpdateRttHistoryCb ( Ptr< const TcpSocketBase tcp,
const SequenceNumber32 seq,
uint32_t  sz,
bool  isRetransmission 
)
private

Update RTT with new data.

Parameters
tcpThe TCP socket.
seqThe sequence number.
szThe segment size.
isRetransmissionTrue if packet is a retransmission.

Definition at line 388 of file tcp-general-test.cc.

References ns3::TcpSocketBase::GetNode(), m_receiverSocket, m_senderSocket, NS_FATAL_ERROR, RECEIVER, SENDER, and UpdatedRttHistory().

Referenced by DoRun().

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

Member Data Documentation

◆ m_congControlTypeId

◆ m_interPacketInterval

Time ns3::TcpGeneralTest::m_interPacketInterval
private

Time between sending application packet down to tcp socket.

Definition at line 1025 of file tcp-general-test.h.

Referenced by DoRun(), GetPktInterval(), and SetAppPktInterval().

◆ m_mtu

uint32_t ns3::TcpGeneralTest::m_mtu
private

MTU of the environment.

Definition at line 1021 of file tcp-general-test.h.

Referenced by DoRun(), GetMtu(), and SetMTU().

◆ m_pktCount

uint32_t ns3::TcpGeneralTest::m_pktCount
private

Count of the application packet.

Definition at line 1024 of file tcp-general-test.h.

Referenced by DoRun(), GetPktCount(), and SetAppPktCount().

◆ m_pktSize

uint32_t ns3::TcpGeneralTest::m_pktSize
private

Size of the application packet.

Definition at line 1023 of file tcp-general-test.h.

Referenced by DoRun(), GetPktSize(), and SetAppPktSize().

◆ m_propagationDelay

Time ns3::TcpGeneralTest::m_propagationDelay
private

Propagation delay of the channel.

Definition at line 1018 of file tcp-general-test.h.

Referenced by CreateChannel(), GetPropagationDelay(), and SetPropagationDelay().

◆ m_receiverSocket

◆ m_recoveryTypeId

TypeId ns3::TcpGeneralTest::m_recoveryTypeId
protected

◆ m_remoteAddr

InetSocketAddress ns3::TcpGeneralTest::m_remoteAddr
private

Remote peer address.

Definition at line 1138 of file tcp-general-test.h.

Referenced by DoConnect(), and DoRun().

◆ m_senderSocket

◆ m_startTime

Time ns3::TcpGeneralTest::m_startTime
private

Data transmission time.

Definition at line 1020 of file tcp-general-test.h.

Referenced by DoRun(), GetStartTime(), and SetTransmitStart().


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