A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
flame-installer.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2008,2009 IITP RAS
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Authors: Kirill Andreev <andreev@iitp.ru>
7
*/
8
9
#ifndef FLAME_INSTALLER_H
10
#define FLAME_INSTALLER_H
11
12
#include "ns3/mesh-stack-installer.h"
13
14
namespace
ns3
15
{
16
17
/**
18
* \ingroup flame
19
*
20
* \brief Helper class used to install FLAME mesh stack (actually single
21
* protocol in this stack)
22
*/
23
class
FlameStack
:
public
MeshStack
24
{
25
public
:
26
/**
27
* \brief Get the type ID.
28
* \return the object TypeId
29
*/
30
static
TypeId
GetTypeId
();
31
32
/**
33
* Construct a FlameStack helper class.
34
*/
35
FlameStack
();
36
37
/**
38
* Destroy a FlameStack helper class.
39
*/
40
~FlameStack
()
override
;
41
42
/**
43
* Break any reference cycles in the installer helper. Required for ns-3
44
* Object support.
45
*/
46
void
DoDispose
()
override
;
47
48
/**
49
* \brief Install a flame stack on the given MeshPointDevice
50
* \param mp The Ptr<MeshPointDevice> to use.
51
* \return true if successful
52
*/
53
bool
InstallStack
(
Ptr<MeshPointDevice>
mp)
override
;
54
55
/**
56
* \brief Print flame protocol statistics.
57
* \param mp The Ptr<MeshPointDevice> to use.
58
* \param os The output stream
59
*/
60
void
Report
(
const
Ptr<MeshPointDevice>
mp, std::ostream&)
override
;
61
62
/**
63
* \brief Reset the statistics.
64
* \param mp The Ptr<MeshPointDevice> to use.
65
*/
66
void
ResetStats
(
const
Ptr<MeshPointDevice>
mp)
override
;
67
};
68
69
}
// namespace ns3
70
71
#endif
/* FLAME_INSTALLER_H */
ns3::FlameStack
Helper class used to install FLAME mesh stack (actually single protocol in this stack)
Definition
flame-installer.h:24
ns3::FlameStack::DoDispose
void DoDispose() override
Break any reference cycles in the installer helper.
Definition
flame-installer.cc:38
ns3::FlameStack::Report
void Report(const Ptr< MeshPointDevice > mp, std::ostream &) override
Print flame protocol statistics.
Definition
flame-installer.cc:50
ns3::FlameStack::~FlameStack
~FlameStack() override
Destroy a FlameStack helper class.
Definition
flame-installer.cc:33
ns3::FlameStack::InstallStack
bool InstallStack(Ptr< MeshPointDevice > mp) override
Install a flame stack on the given MeshPointDevice.
Definition
flame-installer.cc:43
ns3::FlameStack::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition
flame-installer.cc:20
ns3::FlameStack::ResetStats
void ResetStats(const Ptr< MeshPointDevice > mp) override
Reset the statistics.
Definition
flame-installer.cc:60
ns3::FlameStack::FlameStack
FlameStack()
Construct a FlameStack helper class.
Definition
flame-installer.cc:29
ns3::MeshStack
Prototype for class, which helps to install MAC-layer routing stack to ns3::MeshPointDevice.
Definition
mesh-stack-installer.h:25
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition
mpi-test-fixtures.h:37
ns3::TypeId
a unique identifier for an interface.
Definition
type-id.h:48
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
mesh
helper
flame
flame-installer.h
Generated on Fri Nov 8 2024 13:59:04 for ns-3 by
1.11.0