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.

	~Ns3TcpStateTestCase () override

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Private Member Functions
void	DoRun () override
	Implementation to actually run this TestCase.

void	DoSetup () override
	Implementation to do any local setup required for this TestCase.

void	DoTeardown () override
	Implementation to do any local setup required for this TestCase.

void	Ipv4L3Rx (std::string context, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
	Check that the received packets are consistent with the trace.

void	Ipv4L3Tx (std::string context, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
	Check that the transmitted packets are consistent with the trace.

void	StartFlow (Ptr< Socket > localSocket, Ipv4Address servAddress, uint16_t servPort)
	Start transmitting a TCP flow.

void	WriteUntilBufferFull (Ptr< Socket > localSocket, uint32_t txSpace)
	Write to the socket until the buffer is full.

Private Attributes
uint32_t	m_currentTxBytes
	Current number of bytes sent.

bool	m_needToClose
	Check if the sending socket need to be closed.

PcapFile	m_pcapFile
	The PCAP ffile.

std::string	m_pcapFilename
	The PCAP filename.

uint32_t	m_testCase
	Testcase number.

uint32_t	m_totalTxBytes
	Total number of bytes to send.

bool	m_writeLogging
	True if write logging.

bool	m_writeResults
	True if write PCAP files.

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

Additional Inherited Members
Public Types inherited from ns3::TestCase
enum class	Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
	How long the test takes to execute. More...

Static Public Attributes inherited from ns3::TestCase
static constexpr auto	QUICK = Duration::QUICK
	Deprecated test duration simple enums.

static constexpr auto	EXTENSIVE = Duration::EXTENSIVE

static constexpr auto	TAKES_FOREVER = Duration::TAKES_FOREVER

Protected Member Functions inherited from ns3::TestCase
	TestCase (std::string name)
	Constructor.

void	AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
	Add an individual child TestCase to this test suite.

TestCase *	GetParent () const
	Get the parent of this TestCase.

bool	IsStatusFailure () const
	Check if any tests failed.

bool	IsStatusSuccess () const
	Check if all tests passed.

void	SetDataDir (std::string directory)
	Set the data directory where reference trace files can be found.

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.

bool	MustAssertOnFailure () const
	Check if this run should assert on failure.

bool	MustContinueOnFailure () const
	Check if this run should continue on failure.

std::string	CreateDataDirFilename (std::string filename)
	Construct the full path to a file in the data directory.

std::string	CreateTempDirFilename (std::string filename)
	Construct the full path to a file in a temporary directory.

Detailed Description

Tests of TCP implementation state machine behavior.

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

Constructor & Destructor Documentation

◆ Ns3TcpStateTestCase() [1/2]

Ns3TcpStateTestCase::Ns3TcpStateTestCase ( )

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

◆ Ns3TcpStateTestCase() [2/2]

Ns3TcpStateTestCase::Ns3TcpStateTestCase ( uint32_t testCase )

Constructor.

Parameters

testCase Testcase number.

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

◆ ~Ns3TcpStateTestCase()

Ns3TcpStateTestCase::~Ns3TcpStateTestCase ( )

inlineoverride

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

Member Function Documentation

◆ DoRun()

void Ns3TcpStateTestCase::DoRun ( )

overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

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

References ns3::NodeContainer::Add(), ns3::Socket::Close(), ns3::Config::Connect(), ns3::Create(), ns3::NodeContainer::Create(), ns3::CreateObject(), ns3::Socket::CreateSocket(), ns3::Simulator::Destroy(), ns3::NetDeviceContainer::Get(), ns3::NodeContainer::Get(), ns3::Ipv4InterfaceContainer::GetAddress(), ns3::Ipv4Address::GetAny(), ns3::TcpSocketFactory::GetTypeId(), ns3::TrafficControlHelper::Install(), Ipv4L3Rx(), Ipv4L3Tx(), ns3::LOG_LEVEL_DEBUG, ns3::LOG_LEVEL_INFO, ns3::LOG_PREFIX_FUNC, ns3::LogComponentEnable(), ns3::LogComponentEnableAll(), m_needToClose, m_testCase, m_totalTxBytes, m_writeLogging, m_writeResults, ns3::MakeCallback(), n1n2, NS_FATAL_ERROR, ns3::Ipv4GlobalRoutingHelper::PopulateRoutingTables(), ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), ns3::Seconds(), ns3::Config::SetDefault(), ns3::TrafficControlHelper::SetRootQueueDisc(), sink, ns3::ApplicationContainer::Start(), StartFlow(), ns3::ApplicationContainer::Stop(), and ns3::Simulator::Stop().

Here is the call graph for this function:

◆ DoSetup()

void Ns3TcpStateTestCase::DoSetup ( )

overrideprivatevirtual

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 157 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 ( )

overrideprivatevirtual

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 182 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 consistent with the trace.

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

Parameters

context	The callback context (unused).
packet	The transmitted packet.
ipv4	The IPv4 object that did send the packet (unused).
interface	The IPv4 interface that did send the packet (unused).

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

References NS_LOG_DEBUG.

Referenced by DoRun().

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 consistent with the trace.

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

Parameters

context	The callback context (unused).
packet	The transmitted packet.
ipv4	The IPv4 object that did send the packet (unused).
interface	The IPv4 interface that did send the packet (unused).

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

References ns3::Create(), ns3::Time::GetMicroSeconds(), ns3::TestCase::IsStatusSuccess(), m_pcapFile, m_writeVectors, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_INFO, NS_TEST_EXPECT_MSG_EQ, PCAP_SNAPLEN, ns3::PcapFile::Read(), 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

localSocket	The sending socket.
servAddress	The IPv4 address of the server (i.e., the destination address).
servPort	The TCP port of the server (i.e., the destination port).

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

References ns3::Time::GetSeconds(), m_writeLogging, ns3::MakeCallback(), ns3::Simulator::Now(), 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

localSocket	The output socket.
txSpace	The space left on the socket (unused).

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

References ns3::Time::GetSeconds(), m_currentTxBytes, m_needToClose, m_totalTxBytes, m_writeLogging, ns3::Simulator::Now(), and NS_ASSERT.

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 83 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 87 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 80 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 79 of file ns3tcp-state-test-suite.cc.

Referenced by DoSetup().

◆ m_testCase

uint32_t Ns3TcpStateTestCase::m_testCase

private

Testcase number.

Definition at line 81 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 82 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 86 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 85 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 84 of file ns3tcp-state-test-suite.cc.

Referenced by DoSetup(), and Ipv4L3Tx().

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

src/test/ns3tcp/ns3tcp-state-test-suite.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ns3TcpStateTestCase() [1/2]

◆ Ns3TcpStateTestCase() [2/2]

◆ ~Ns3TcpStateTestCase()

Member Function Documentation

◆ DoRun()

◆ DoSetup()

◆ DoTeardown()

◆ Ipv4L3Rx()

◆ Ipv4L3Tx()

◆ StartFlow()

◆ WriteUntilBufferFull()

Member Data Documentation

◆ m_currentTxBytes

◆ m_needToClose

◆ m_pcapFile

◆ m_pcapFilename

◆ m_testCase

◆ m_totalTxBytes

◆ m_writeLogging

◆ m_writeResults

◆ m_writeVectors