A Discrete-Event Network Simulator
API
mpi-receiver.cc
Go to the documentation of this file.
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation;
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
14  *
15  * Author: George Riley <riley@ece.gatech.edu>
16  */
17 
25 #include "mpi-receiver.h"
26 
27 namespace ns3
28 {
29 
30 TypeId
31 MpiReceiver::GetTypeId()
32 {
33  static TypeId tid = TypeId("ns3::MpiReceiver")
34  .SetParent<Object>()
35  .SetGroupName("Mpi")
36  .AddConstructor<MpiReceiver>();
37  return tid;
38 }
39 
40 MpiReceiver::~MpiReceiver()
41 {
42 }
43 
44 void
45 MpiReceiver::SetReceiveCallback(Callback<void, Ptr<Packet>> callback)
46 {
47  m_rxCallback = callback;
48 }
49 
50 void
51 MpiReceiver::Receive(Ptr<Packet> p)
52 {
53  NS_ASSERT(!m_rxCallback.IsNull());
54  m_rxCallback(p);
55 }
56 
57 void
58 MpiReceiver::DoDispose()
59 {
60  m_rxCallback = MakeNullCallback<void, Ptr<Packet>>();
61 }
62 
63 } // namespace ns3
ns3::Callback
Callback template class.
Definition: callback.h:438
ns3::Callback::IsNull
bool IsNull() const
Check for null implementation.
Definition: callback.h:569
ns3::MpiReceiver
Class to aggregate to a NetDevice if it supports MPI capability.
Definition: mpi-receiver.h:48
ns3::MpiReceiver::m_rxCallback
Callback< void, Ptr< Packet > > m_rxCallback
Callback to send received packets to.
Definition: mpi-receiver.h:72
ns3::MpiReceiver::SetReceiveCallback
void SetReceiveCallback(Callback< void, Ptr< Packet >> callback)
Set the receive callback to get packets to net devices.
Definition: mpi-receiver.cc:45
ns3::MpiReceiver::Receive
void Receive(Ptr< Packet > p)
Direct an incoming packet to the device Receive() method.
Definition: mpi-receiver.cc:51
ns3::MpiReceiver::GetTypeId
static TypeId GetTypeId()
Register this type.
Definition: mpi-receiver.cc:31
ns3::MpiReceiver::DoDispose
void DoDispose() override
Destructor implementation.
Definition: mpi-receiver.cc:58
ns3::MpiReceiver::~MpiReceiver
~MpiReceiver() override
Definition: mpi-receiver.cc:40
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:89
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::TypeId::SetParent
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
NS_ASSERT
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
mpi-receiver.h
ns3::MpiReceiver declaration, provides an interface to aggregate to MPI-compatible NetDevices.
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.