A Discrete-Event Network Simulator
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
14namespace 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 */
23class 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 */
Helper class used to install FLAME mesh stack (actually single protocol in this stack)
void DoDispose() override
Break any reference cycles in the installer helper.
void Report(const Ptr< MeshPointDevice > mp, std::ostream &) override
Print flame protocol statistics.
~FlameStack() override
Destroy a FlameStack helper class.
bool InstallStack(Ptr< MeshPointDevice > mp) override
Install a flame stack on the given MeshPointDevice.
static TypeId GetTypeId()
Get the type ID.
void ResetStats(const Ptr< MeshPointDevice > mp) override
Reset the statistics.
FlameStack()
Construct a FlameStack helper class.
Prototype for class, which helps to install MAC-layer routing stack to ns3::MeshPointDevice.
Smart pointer class similar to boost::intrusive_ptr.
a unique identifier for an interface.
Definition type-id.h:48
Every class exported by the ns3 library is enclosed in the ns3 namespace.