A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
tc-regression-test.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2009 IITP RAS
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: Pavel Boyko <boyko@iitp.ru>
7 */
8
9#ifndef TC_REGRESSION_TEST_H
10#define TC_REGRESSION_TEST_H
11
12#include "ns3/ipv4-raw-socket-impl.h"
13#include "ns3/node-container.h"
14#include "ns3/nstime.h"
15#include "ns3/socket.h"
16#include "ns3/test.h"
17
18namespace ns3
19{
20namespace olsr
21{
22/**
23 * @ingroup olsr-test
24 * @ingroup tests
25 *
26 * @brief Less trivial test of OLSR Topology Control message generation
27 *
28 * This test simulates 3 Wi-Fi stations with chain topology and runs OLSR without any extra traffic.
29 * It is expected that only second station will send TC messages.
30 *
31 * Expected trace (20 seconds, note random b-cast jitter):
32 */
33// clang-format off
34/**
35 * \verbatim
36 1 2 3
37 |<------|------>| HELLO (empty) src = 10.1.1.2
38 | |<------|------> HELLO (empty) src = 10.1.1.3
39 <------|------>| | HELLO (empty) src = 10.1.1.1
40 <------|------>| | HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.2) src = 10.1.1.1
41 | |<------|------> HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.2) src = 10.1.1.3
42 |<------|------>| HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.3; Link Type: Asymmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
43 |<------|------>| HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.3; Link Type: Asymmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
44 <------|------>| | HELLO (Link Type: Symmetric, Neighbor: 10.1.1.2) src = 10.1.1.1
45 | |<------|------> HELLO (Link Type: Symmetric, Neighbor: 10.1.1.2) src = 10.1.1.3
46 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
47 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
48 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
49 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
50 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
51 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
52 |<======|======>| TC (10.1.1.3; 10.1.1.1) + HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
53 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
54 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
55 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
56 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
57 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
58 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
59 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
60 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
61 |<======|======>| TC (10.1.1.3; 10.1.1.1) src = 10.1.1.2
62 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
63 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
64 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
65 <------|------>| | HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1
66 | |<------|------> HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3
67 |<------|------>| HELLO (Link Type: Symmetric, Neighbor: 10.1.1.3; Link Type: Symmetric, Neighbor: 10.1.1.1) src = 10.1.1.2
68 \endverbatim
69 */
70// clang-format on
71
72class TcRegressionTest : public TestCase
73{
74 public:
75 TcRegressionTest();
76 ~TcRegressionTest() override;
77
78 private:
79 /// Total simulation time
80 const Time m_time;
81 /// Create & configure test network
82 void CreateNodes();
83 void DoRun() override;
84
85 /**
86 * Receive raw data on node A
87 * @param socket receiving socket
88 */
89 void ReceivePktProbeA(Ptr<Socket> socket);
90 /// Packet counter on node A
91 uint8_t m_countA;
92 /// Receiving socket on node A
93 Ptr<Ipv4RawSocketImpl> m_rxSocketA;
94
95 /**
96 * Receive raw data on node B
97 * @param socket receiving socket
98 */
99 void ReceivePktProbeB(Ptr<Socket> socket);
100 /// Packet counter on node B
101 uint8_t m_countB;
102 /// Receiving socket on node B
103 Ptr<Ipv4RawSocketImpl> m_rxSocketB;
104
105 /**
106 * Receive raw data on node C
107 * @param socket receiving socket
108 */
109 void ReceivePktProbeC(Ptr<Socket> socket);
110 /// Packet counter on node C
111 uint8_t m_countC;
112 /// Receiving socket on node C
113 Ptr<Ipv4RawSocketImpl> m_rxSocketC;
114};
115
116} // namespace olsr
117} // namespace ns3
118
119#endif /* TC_REGRESSION_TEST_H */
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition mpi-test-fixtures.h:37
ns3::TestCase
encapsulates test code
Definition test.h:1050
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
ns3::olsr::TcRegressionTest
Less trivial test of OLSR Topology Control message generation.
Definition tc-regression-test.h:73
ns3::olsr::TcRegressionTest::CreateNodes
void CreateNodes()
Create & configure test network.
Definition tc-regression-test.cc:65
ns3::olsr::TcRegressionTest::ReceivePktProbeB
void ReceivePktProbeB(Ptr< Socket > socket)
Receive raw data on node B.
Definition tc-regression-test.cc:219
ns3::olsr::TcRegressionTest::m_countB
uint8_t m_countB
Packet counter on node B.
Definition tc-regression-test.h:101
ns3::olsr::TcRegressionTest::m_rxSocketB
Ptr< Ipv4RawSocketImpl > m_rxSocketB
Receiving socket on node B.
Definition tc-regression-test.h:103
ns3::olsr::TcRegressionTest::ReceivePktProbeC
void ReceivePktProbeC(Ptr< Socket > socket)
Receive raw data on node C.
Definition tc-regression-test.cc:291
ns3::olsr::TcRegressionTest::m_countC
uint8_t m_countC
Packet counter on node C.
Definition tc-regression-test.h:111
ns3::olsr::TcRegressionTest::DoRun
void DoRun() override
Implementation to actually run this TestCase.
Definition tc-regression-test.cc:49
ns3::olsr::TcRegressionTest::m_rxSocketC
Ptr< Ipv4RawSocketImpl > m_rxSocketC
Receiving socket on node C.
Definition tc-regression-test.h:113
ns3::olsr::TcRegressionTest::ReceivePktProbeA
void ReceivePktProbeA(Ptr< Socket > socket)
Receive raw data on node A.
Definition tc-regression-test.cc:116
ns3::olsr::TcRegressionTest::m_time
const Time m_time
Total simulation time.
Definition tc-regression-test.h:80
ns3::olsr::TcRegressionTest::m_rxSocketA
Ptr< Ipv4RawSocketImpl > m_rxSocketA
Receiving socket on node A.
Definition tc-regression-test.h:93
ns3::olsr::TcRegressionTest::m_countA
uint8_t m_countA
Packet counter on node A.
Definition tc-regression-test.h:91
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
olsr
Definition olsr.py:1