A Discrete-Event Network Simulator
API
Ns3TcpStateTestCase Class Reference

Tests of TCP implementation state machine behavior. More...

+ Inheritance diagram for Ns3TcpStateTestCase:
+ Collaboration diagram for Ns3TcpStateTestCase:

Public Member Functions

 Ns3TcpStateTestCase ()
 
 Ns3TcpStateTestCase (uint32_t testCase)
 Constructor. More...
 
virtual ~Ns3TcpStateTestCase ()
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

virtual void DoRun (void)
 Implementation to actually run this TestCase. More...
 
virtual void DoSetup (void)
 Implementation to do any local setup required for this TestCase. More...
 
virtual void DoTeardown (void)
 Implementation to do any local setup required for this TestCase. More...
 
void Ipv4L3Rx (std::string context, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
 Check that the received packets are consitent with the trace. More...
 
void Ipv4L3Tx (std::string context, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
 Check that the transmitted packets are consitent with the trace. More...
 
void StartFlow (Ptr< Socket > localSocket, Ipv4Address servAddress, uint16_t servPort)
 Start transmitting a TCP flow. More...
 
void WriteUntilBufferFull (Ptr< Socket > localSocket, uint32_t txSpace)
 Write to the socket until the buffer is full. More...
 

Private Attributes

uint32_t m_currentTxBytes
 Current number of bytes sent. More...
 
bool m_needToClose
 Check if the sending socket need to be closed. More...
 
PcapFile m_pcapFile
 The PCAP ffile. More...
 
std::string m_pcapFilename
 The PCAP filename. More...
 
uint32_t m_testCase
 Testcase number. More...
 
uint32_t m_totalTxBytes
 Total number of bytes to send. More...
 
bool m_writeLogging
 True if write logging. More...
 
bool m_writeResults
 True if write PCAP files. More...
 
bool m_writeVectors
 True if response vectors have to be written (and not read). More...
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. 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...
 

Detailed Description

Tests of TCP implementation state machine behavior.

Definition at line 71 of file ns3tcp-state-test-suite.cc.

Constructor & Destructor Documentation

◆ Ns3TcpStateTestCase() [1/2]

Ns3TcpStateTestCase::Ns3TcpStateTestCase ( )

Definition at line 139 of file ns3tcp-state-test-suite.cc.

◆ Ns3TcpStateTestCase() [2/2]

Ns3TcpStateTestCase::Ns3TcpStateTestCase ( uint32_t  testCase)

Constructor.

Parameters
testCaseTestcase number.

Definition at line 151 of file ns3tcp-state-test-suite.cc.

◆ ~Ns3TcpStateTestCase()

virtual Ns3TcpStateTestCase::~Ns3TcpStateTestCase ( )
inlinevirtual

Definition at line 80 of file ns3tcp-state-test-suite.cc.

Member Function Documentation

◆ DoRun()

◆ DoSetup()

void Ns3TcpStateTestCase::DoSetup ( void  )
privatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test setup before DoRun is invoked.

Reimplemented from ns3::TestCase.

Definition at line 164 of file ns3tcp-state-test-suite.cc.

References ns3::TestCase::CreateDataDirFilename(), ns3::PcapFile::GetDataLinkType(), ns3::PcapFile::Init(), m_pcapFile, m_pcapFilename, m_testCase, m_writeVectors, NS_ABORT_MSG_UNLESS, NS_LOG_INFO, ns3::PcapFile::Open(), PCAP_LINK_TYPE, and PCAP_SNAPLEN.

+ Here is the call graph for this function:

◆ DoTeardown()

void Ns3TcpStateTestCase::DoTeardown ( void  )
privatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test teardown

Reimplemented from ns3::TestCase.

Definition at line 190 of file ns3tcp-state-test-suite.cc.

References ns3::PcapFile::Close(), and m_pcapFile.

+ Here is the call graph for this function:

◆ Ipv4L3Rx()

void Ns3TcpStateTestCase::Ipv4L3Rx ( std::string  context,
Ptr< const Packet packet,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)
private

Check that the received packets are consitent with the trace.

This callback is hooked to ns3::Ipv4L3Protocol/Tx.

Parameters
contextThe callback context (unused).
packetThe transmitted packet.
ipv4The IPv4 object that did send the packet (unused).
interfaceThe IPv4 interface that did send the packet (unused).

Definition at line 196 of file ns3tcp-state-test-suite.cc.

References ns3::Packet::Copy(), NS_LOG_DEBUG, and ns3::Packet::RemoveHeader().

Referenced by DoRun().

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

◆ Ipv4L3Tx()

void Ns3TcpStateTestCase::Ipv4L3Tx ( std::string  context,
Ptr< const Packet packet,
Ptr< Ipv4 ipv4,
uint32_t  interface 
)
private

Check that the transmitted packets are consitent with the trace.

This callback is hooked to ns3::Ipv4L3Protocol/Tx.

Parameters
contextThe callback context (unused).
packetThe transmitted packet.
ipv4The IPv4 object that did send the packet (unused).
interfaceThe IPv4 interface that did send the packet (unused).

Definition at line 208 of file ns3tcp-state-test-suite.cc.

References ns3::Packet::Copy(), ns3::Packet::CopyData(), ns3::Time::GetMicroSeconds(), ns3::TestCase::IsStatusSuccess(), m_pcapFile, m_writeVectors, ns3::Now(), NS_LOG_DEBUG, NS_LOG_INFO, NS_TEST_EXPECT_MSG_EQ, PCAP_SNAPLEN, ns3::PcapFile::Read(), ns3::Packet::RemoveHeader(), test-ns3::result, and ns3::PcapFile::Write().

Referenced by DoRun().

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

◆ StartFlow()

void Ns3TcpStateTestCase::StartFlow ( Ptr< Socket localSocket,
Ipv4Address  servAddress,
uint16_t  servPort 
)
private

Start transmitting a TCP flow.

Parameters
localSocketThe sending socket.
servAddressThe IPv4 address of the server (i.e., the destination address).
servPortThe TCP port of the server (i.e., the destination port).

Definition at line 312 of file ns3tcp-state-test-suite.cc.

References ns3::Socket::Connect(), ns3::Time::GetSeconds(), ns3::Socket::GetTxAvailable(), m_writeLogging, ns3::MakeCallback(), ns3::Now(), ns3::Socket::SetSendCallback(), and WriteUntilBufferFull().

Referenced by DoRun().

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

◆ WriteUntilBufferFull()

void Ns3TcpStateTestCase::WriteUntilBufferFull ( Ptr< Socket localSocket,
uint32_t  txSpace 
)
private

Write to the socket until the buffer is full.

Parameters
localSocketThe output socket.
txSpaceThe space left on the socket (unused).

Definition at line 275 of file ns3tcp-state-test-suite.cc.

References ns3::Socket::Close(), ns3::Time::GetSeconds(), ns3::Socket::GetTxAvailable(), m_currentTxBytes, m_needToClose, m_totalTxBytes, m_writeLogging, min, ns3::Now(), NS_ASSERT, and ns3::Socket::Send().

Referenced by StartFlow().

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

Member Data Documentation

◆ m_currentTxBytes

uint32_t Ns3TcpStateTestCase::m_currentTxBytes
private

Current number of bytes sent.

Definition at line 93 of file ns3tcp-state-test-suite.cc.

Referenced by WriteUntilBufferFull().

◆ m_needToClose

bool Ns3TcpStateTestCase::m_needToClose
private

Check if the sending socket need to be closed.

Definition at line 97 of file ns3tcp-state-test-suite.cc.

Referenced by DoRun(), and WriteUntilBufferFull().

◆ m_pcapFile

PcapFile Ns3TcpStateTestCase::m_pcapFile
private

The PCAP ffile.

Definition at line 90 of file ns3tcp-state-test-suite.cc.

Referenced by DoSetup(), DoTeardown(), and Ipv4L3Tx().

◆ m_pcapFilename

std::string Ns3TcpStateTestCase::m_pcapFilename
private

The PCAP filename.

Definition at line 89 of file ns3tcp-state-test-suite.cc.

Referenced by DoSetup().

◆ m_testCase

uint32_t Ns3TcpStateTestCase::m_testCase
private

Testcase number.

Definition at line 91 of file ns3tcp-state-test-suite.cc.

Referenced by DoRun(), and DoSetup().

◆ m_totalTxBytes

uint32_t Ns3TcpStateTestCase::m_totalTxBytes
private

Total number of bytes to send.

Definition at line 92 of file ns3tcp-state-test-suite.cc.

Referenced by DoRun(), and WriteUntilBufferFull().

◆ m_writeLogging

bool Ns3TcpStateTestCase::m_writeLogging
private

True if write logging.

Definition at line 96 of file ns3tcp-state-test-suite.cc.

Referenced by DoRun(), StartFlow(), and WriteUntilBufferFull().

◆ m_writeResults

bool Ns3TcpStateTestCase::m_writeResults
private

True if write PCAP files.

Definition at line 95 of file ns3tcp-state-test-suite.cc.

Referenced by DoRun().

◆ m_writeVectors

bool Ns3TcpStateTestCase::m_writeVectors
private

True if response vectors have to be written (and not read).

Definition at line 94 of file ns3tcp-state-test-suite.cc.

Referenced by DoSetup(), and Ipv4L3Tx().


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