A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
uan-mac-aloha.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 University of Washington
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: Leonard Tracy <lentracy@gmail.com>
19  */
20 
21 #include "uan-mac-aloha.h"
22 #include "uan-tx-mode.h"
23 #include "uan-address.h"
24 #include "ns3/log.h"
25 #include "uan-phy.h"
26 #include "uan-header-common.h"
27 
28 #include <iostream>
29 NS_LOG_COMPONENT_DEFINE ("UanMacAloha");
30 
31 
32 namespace ns3
33 {
34 
35 NS_OBJECT_ENSURE_REGISTERED (UanMacAloha);
36 
38  : UanMac (),
39  m_cleared (false)
40 {
41 }
42 
44 {
45 }
46 
47 void
49 {
50  if (m_cleared)
51  {
52  return;
53  }
54  m_cleared = true;
55  if (m_phy)
56  {
57  m_phy->Clear ();
58  m_phy = 0;
59  }
60 }
61 
62 void
64 {
65  Clear ();
67 }
68 
69 TypeId
71 {
72  static TypeId tid = TypeId ("ns3::UanMacAloha")
73  .SetParent<Object> ()
74  .AddConstructor<UanMacAloha> ()
75  ;
76  return tid;
77 }
78 
79 Address
81 {
82  return m_address;
83 }
84 
85 void
87 {
88  m_address=addr;
89 }
90 bool
91 UanMacAloha::Enqueue (Ptr<Packet> packet, const Address &dest, uint16_t protocolNumber)
92 {
93  NS_LOG_DEBUG ("" << Simulator::Now ().GetSeconds () << " MAC " << UanAddress::ConvertFrom (GetAddress ()) << " Queueing packet for " << UanAddress::ConvertFrom (dest));
94 
95  if (!m_phy->IsStateTx ())
96  {
98  UanAddress udest = UanAddress::ConvertFrom (dest);
99 
100  UanHeaderCommon header;
101  header.SetSrc (src);
102  header.SetDest (udest);
103  header.SetType (0);
104 
105  packet->AddHeader (header);
106  m_phy->SendPacket (packet, protocolNumber);
107  return true;
108  }
109  else
110  return false;
111 }
112 
113 void
115 {
116  m_forUpCb = cb;
117 }
118 void
120 {
121  m_phy = phy;
122  m_phy->SetReceiveOkCallback (MakeCallback (&UanMacAloha::RxPacketGood, this));
123  m_phy->SetReceiveErrorCallback (MakeCallback (&UanMacAloha::RxPacketError, this));
124 
125 }
126 void
128 {
129  UanHeaderCommon header;
130  pkt->RemoveHeader (header);
131  NS_LOG_DEBUG ("Receiving packet from " << header.GetSrc () << " For " << header.GetDest ());
132 
133  if (header.GetDest () == GetAddress () || header.GetDest () == UanAddress::GetBroadcast ())
134  {
135  m_forUpCb (pkt, header.GetSrc ());
136  }
137 
138 }
139 
140 void
142 {
143  NS_LOG_DEBUG ("" << Simulator::Now () << " MAC " << UanAddress::ConvertFrom (GetAddress ()) << " Received packet in error with sinr " << sinr);
144 }
145 
146 Address
148 {
149  UanAddress broadcast (255);
150  return broadcast;
151 }
152 
153 int64_t
155 {
156  NS_LOG_FUNCTION (this << stream);
157  return 0;
158 }
159 
160 }
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:268
Ptr< UanPhy > m_phy
PHY layer attached to this MAC.
Definition: uan-mac-aloha.h:71
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
Callback template class.
Definition: callback.h:924
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register the class in the ns-3 factory.
Definition: object-base.h:38
virtual void SetAddress(UanAddress addr)
Set the address.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
Callback< void, Ptr< Packet >, const UanAddress & > m_forUpCb
Forwarding up callback.
Definition: uan-mac-aloha.h:73
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: object.cc:335
Address GetAddress(void)
Get the MAC Address.
virtual Address GetBroadcast(void) const
Get the broadcast address.
a polymophic address class
Definition: address.h:86
Virtual base class for all UAN MAC protocols.
Definition: uan-mac.h:47
A class used for addressing UAN MAC's.
Definition: uan-address.h:40
static UanAddress ConvertFrom(const Address &address)
Convert a generic address to a UanAddress.
Definition: uan-address.cc:54
void SetSrc(UanAddress src)
Set the source address.
void RxPacketGood(Ptr< Packet > pkt, double sinr, UanTxMode txMode)
Receive packet from lower layer (passed to PHY as callback).
virtual void SetForwardUpCb(Callback< void, Ptr< Packet >, const UanAddress & > cb)
Set the callback to forward packets up to higher layers.
Abstraction of packet modulation information.
Definition: uan-tx-mode.h:41
static TypeId GetTypeId(void)
Register this type.
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1242
void SetDest(UanAddress dest)
Set the destination address.
void RxPacketError(Ptr< Packet > pkt, double sinr)
Packet received at lower layer in error.
virtual ~UanMacAloha()
Dummy destructor, see DoDispose.
static UanAddress GetBroadcast(void)
Get the broadcast address (255).
Definition: uan-address.cc:92
Common packet header fields.
UanAddress GetDest(void) const
Get the destination address.
virtual void Clear(void)
Clears all pointer references.
virtual bool Enqueue(Ptr< Packet > pkt, const Address &dest, uint16_t protocolNumber)
Enqueue packet to be transmitted.
static Time Now(void)
Return the "current simulation time".
Definition: simulator.cc:180
bool m_cleared
Flag when we've been cleared.
Definition: uan-mac-aloha.h:75
virtual void AttachPhy(Ptr< UanPhy > phy)
Attach PHY layer to this MAC.
UanMacAloha()
Default constructor.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:213
void SetType(uint8_t type)
Set the header type.
UanAddress GetSrc(void) const
Get the source address.
virtual void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
a base class which provides memory management and object aggregation
Definition: object.h:64
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
UanAddress m_address
The MAC address.
Definition: uan-mac-aloha.h:69
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:253