A Discrete-Event Network Simulator
API
simple-channel.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef SIMPLE_CHANNEL_H
21 #define SIMPLE_CHANNEL_H
22 
23 #include "ns3/channel.h"
24 #include "ns3/nstime.h"
25 #include "mac48-address.h"
26 #include <vector>
27 #include <map>
28 
29 namespace ns3 {
30 
31 class SimpleNetDevice;
32 class Packet;
33 
46 class SimpleChannel : public Channel
47 {
48 public:
53  static TypeId GetTypeId (void);
54  SimpleChannel ();
55 
68  virtual void Send (Ptr<Packet> p, uint16_t protocol, Mac48Address to, Mac48Address from,
69  Ptr<SimpleNetDevice> sender);
70 
76  virtual void Add (Ptr<SimpleNetDevice> device);
77 
85  virtual void BlackList (Ptr<SimpleNetDevice> from, Ptr<SimpleNetDevice> to);
86 
95 
96  // inherited from ns3::Channel
97  virtual std::size_t GetNDevices (void) const;
98  virtual Ptr<NetDevice> GetDevice (std::size_t i) const;
99 
100 private:
102  std::vector<Ptr<SimpleNetDevice> > m_devices;
103  std::map<Ptr<SimpleNetDevice>, std::vector<Ptr<SimpleNetDevice> > > m_blackListedDevices;
104 };
105 
106 } // namespace ns3
107 
108 #endif /* SIMPLE_CHANNEL_H */
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
virtual void Add(Ptr< SimpleNetDevice > device)
Attached a net device to the channel.
Abstract Channel Base Class.
Definition: channel.h:43
virtual void Send(Ptr< Packet > p, uint16_t protocol, Mac48Address to, Mac48Address from, Ptr< SimpleNetDevice > sender)
A packet is sent by a net device.
virtual void UnBlackList(Ptr< SimpleNetDevice > from, Ptr< SimpleNetDevice > to)
Un-Blocks the communications from a NetDevice to another NetDevice.
std::map< Ptr< SimpleNetDevice >, std::vector< Ptr< SimpleNetDevice > > > m_blackListedDevices
devices blocked on a device
Every class exported by the ns3 library is enclosed in the ns3 namespace.
an EUI-48 address
Definition: mac48-address.h:43
std::vector< Ptr< SimpleNetDevice > > m_devices
devices connected by the channel
Time m_delay
The assigned speed-of-light delay of the channel.
virtual std::size_t GetNDevices(void) const
A simple channel, for simple things and testing.
virtual Ptr< NetDevice > GetDevice(std::size_t i) const
a unique identifier for an interface.
Definition: type-id.h:58
virtual void BlackList(Ptr< SimpleNetDevice > from, Ptr< SimpleNetDevice > to)
Blocks the communications from a NetDevice to another NetDevice.
static TypeId GetTypeId(void)
Get the type ID.