ns-3
|
Hold together all Wimax-related objects in a NetDevice.This class holds together ns3::WimaxPhy, ns3::WimaxConnection, ns3::ConectionManager, ns3::BurstProfileManager, and ns3::BandwidthManager. More...
#include <wimax-net-device.h>
Public Types | |
enum | Direction { DIRECTION_DOWNLINK, DIRECTION_UPLINK } |
enum | RangingStatus { RANGING_STATUS_EXPIRED, RANGING_STATUS_CONTINUE, RANGING_STATUS_ABORT, RANGING_STATUS_SUCCESS } |
Public Member Functions | |
void | SetTtg (uint16_t ttg) |
uint16_t | GetTtg (void) const |
void | SetRtg (uint16_t rtg) |
uint16_t | GetRtg (void) const |
void | Attach (Ptr< WimaxChannel > channel) |
void | SetPhy (Ptr< WimaxPhy > phy) |
Ptr< WimaxPhy > | GetPhy (void) const |
void | SetChannel (Ptr< WimaxChannel > wimaxChannel) |
uint64_t | GetChannel (uint8_t index) const |
void | SetNrFrames (uint32_t nrFrames) |
uint32_t | GetNrFrames (void) const |
void | SetMacAddress (Mac48Address address) |
Mac48Address | GetMacAddress (void) const |
void | SetState (uint8_t state) |
uint8_t | GetState (void) const |
Ptr< WimaxConnection > | GetInitialRangingConnection (void) const |
Ptr< WimaxConnection > | GetBroadcastConnection (void) const |
void | SetCurrentDcd (Dcd dcd) |
Dcd | GetCurrentDcd (void) const |
void | SetCurrentUcd (Ucd ucd) |
Ucd | GetCurrentUcd (void) const |
Ptr< ConnectionManager > | GetConnectionManager (void) const |
virtual void | SetConnectionManager (Ptr< ConnectionManager > connectionManager) |
Ptr< BurstProfileManager > | GetBurstProfileManager (void) const |
void | SetBurstProfileManager (Ptr< BurstProfileManager > burstProfileManager) |
Ptr< BandwidthManager > | GetBandwidthManager (void) const |
void | SetBandwidthManager (Ptr< BandwidthManager > bandwidthManager) |
void | CreateDefaultConnections (void) |
virtual void | Start (void)=0 |
virtual void | Stop (void)=0 |
void | SetReceiveCallback (void) |
void | ForwardUp (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest) |
virtual bool | Enqueue (Ptr< Packet > packet, const MacHeaderType &hdrType, Ptr< WimaxConnection > connection)=0 |
void | ForwardDown (Ptr< PacketBurst > burst, WimaxPhy::ModulationType modulationType) |
virtual void | SetName (const std::string name) |
virtual std::string | GetName (void) const |
virtual void | SetIfIndex (const uint32_t index) |
virtual uint32_t | GetIfIndex (void) const |
virtual Ptr< Channel > | GetPhyChannel (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual void | SetAddress (Address address) |
virtual Address | GetAddress (void) const |
virtual bool | SetMtu (const uint16_t mtu) |
virtual uint16_t | GetMtu (void) const |
virtual bool | IsLinkUp (void) const |
virtual void | SetLinkChangeCallback (Callback< void > callback) |
virtual bool | IsBroadcast (void) const |
virtual Address | GetBroadcast (void) const |
virtual bool | IsMulticast (void) const |
virtual Address | GetMulticast (void) const |
virtual Address | MakeMulticastAddress (Ipv4Address multicastGroup) const |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. | |
virtual bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) |
virtual void | SetNode (Ptr< Node > node) |
virtual Ptr< Node > | GetNode (void) const |
virtual bool | NeedsArp (void) const |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
virtual bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
NetDevice::PromiscReceiveCallback | GetPromiscReceiveCallback (void) |
virtual bool | SupportsSendFrom (void) const |
virtual void | DoDispose (void) |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. | |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. | |
bool | IsPromisc (void) |
void | NotifyPromiscTrace (Ptr< Packet > p) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::WimaxNetDevice. | |
Public Attributes | |
TracedCallback< Ptr< const Packet >, const Mac48Address & > | m_traceRx |
TracedCallback< Ptr< const Packet >, const Mac48Address & > | m_traceTx |
Static Public Attributes | |
static uint8_t | m_direction = ~0 |
static Time | m_frameStartTime = Seconds (0) |
Hold together all Wimax-related objects in a NetDevice.
This class holds together ns3::WimaxPhy, ns3::WimaxConnection, ns3::ConectionManager, ns3::BurstProfileManager, and ns3::BandwidthManager.
void ns3::WimaxNetDevice::AddLinkChangeCallback | ( | Callback< void > | callback | ) | [virtual] |
callback | the callback to invoke |
Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.
Implements ns3::NetDevice.
References NS_FATAL_ERROR.
void ns3::WimaxNetDevice::DoDispose | ( | void | ) | [virtual] |
This method is called by Object::Dispose or by the object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.
It is safe to call GetObject from within this method.
Reimplemented from ns3::Object.
References ns3::Object::Dispose().
Address ns3::WimaxNetDevice::GetAddress | ( | void | ) | const [virtual] |
Ptr< BandwidthManager > ns3::WimaxNetDevice::GetBandwidthManager | ( | void | ) | const |
Referenced by GetTypeId(), ns3::UplinkSchedulerRtps::Schedule(), and ns3::BaseStationNetDevice::Start().
Address ns3::WimaxNetDevice::GetBroadcast | ( | void | ) | const [virtual] |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Ptr< WimaxConnection > ns3::WimaxNetDevice::GetBroadcastConnection | ( | void | ) | const |
Referenced by ns3::BSSchedulerRtps::Schedule().
Ptr< BurstProfileManager > ns3::WimaxNetDevice::GetBurstProfileManager | ( | void | ) | const |
Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), GetTypeId(), and ns3::SubscriberStationNetDevice::SendBurst().
Implements ns3::NetDevice.
Ptr< ConnectionManager > ns3::WimaxNetDevice::GetConnectionManager | ( | void | ) | const |
Referenced by ns3::BsServiceFlowManager::AddMulticastServiceFlow(), GetTypeId(), ns3::BsServiceFlowManager::ProcessDsaReq(), ns3::BSSchedulerRtps::Schedule(), and ns3::BaseStationNetDevice::Start().
uint32_t ns3::WimaxNetDevice::GetIfIndex | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
Ptr< WimaxConnection > ns3::WimaxNetDevice::GetInitialRangingConnection | ( | void | ) | const |
Referenced by ns3::BSSchedulerRtps::Schedule().
Mac48Address ns3::WimaxNetDevice::GetMacAddress | ( | void | ) | const |
Referenced by ns3::SubscriberStationNetDevice::SendBurst().
uint16_t ns3::WimaxNetDevice::GetMtu | ( | void | ) | const [virtual] |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Referenced by GetTypeId().
Address ns3::WimaxNetDevice::GetMulticast | ( | Ipv6Address | addr | ) | const [virtual] |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
References ns3::Mac48Address::GetMulticast(), and NS_LOG_LOGIC.
Address ns3::WimaxNetDevice::GetMulticast | ( | Ipv4Address | multicastGroup | ) | const [virtual] |
Make and return a MAC multicast address using the provided multicast group.
RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. This method performs the multicast address creation function appropriate to the underlying MAC address of the device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact MAC address format.
In the case of net devices that do not support multicast, clients are expected to test NetDevice::IsMulticast and avoid attempting to map multicast packets. Subclasses of NetDevice that do support multicasting are expected to override this method and provide an implementation appropriate to the particular device.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
References ns3::Mac48Address::GetMulticast(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Ptr< Node > ns3::WimaxNetDevice::GetNode | ( | void | ) | const [virtual] |
When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.
Implements ns3::NetDevice.
Ptr< WimaxPhy > ns3::WimaxNetDevice::GetPhy | ( | void | ) | const |
Referenced by ns3::BSSchedulerRtps::BSSchedulerRTPSConnection(), ns3::UplinkSchedulerMBQoS::CheckDeadline(), ns3::UplinkSchedulerMBQoS::CountSymbolsJobs(), GetTypeId(), ns3::SSScheduler::Schedule(), ns3::UplinkSchedulerRtps::Schedule(), ns3::BaseStationNetDevice::Start(), ns3::SubscriberStationNetDevice::Start(), and ns3::UplinkSchedulerRtps::ULSchedulerRTPSConnection().
uint16_t ns3::WimaxNetDevice::GetRtg | ( | void | ) | const |
Referenced by GetTypeId(), and ns3::BaseStationNetDevice::Start().
uint16_t ns3::WimaxNetDevice::GetTtg | ( | void | ) | const |
Referenced by GetTypeId(), and ns3::BaseStationNetDevice::Start().
TypeId ns3::WimaxNetDevice::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::WimaxNetDevice.
This object is accessible through the following paths with Config::Set and Config::Connect:
Attributes defined for this type:
TraceSources defined for this type:
Reimplemented from ns3::NetDevice.
Reimplemented in ns3::SubscriberStationNetDevice, and ns3::BaseStationNetDevice.
References GetBandwidthManager(), GetBurstProfileManager(), GetConnectionManager(), GetMtu(), GetPhy(), GetRtg(), GetTtg(), ns3::MakeTraceSourceAccessor(), SetBandwidthManager(), SetBurstProfileManager(), SetChannel(), SetConnectionManager(), SetMtu(), ns3::TypeId::SetParent(), SetPhy(), SetRtg(), and SetTtg().
bool ns3::WimaxNetDevice::IsBridge | ( | void | ) | const [virtual] |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
References NS_LOG_FUNCTION_NOARGS.
bool ns3::WimaxNetDevice::IsBroadcast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
bool ns3::WimaxNetDevice::IsLinkUp | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
bool ns3::WimaxNetDevice::IsMulticast | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.
bool ns3::WimaxNetDevice::IsPointToPoint | ( | void | ) | const [virtual] |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
bool ns3::WimaxNetDevice::NeedsArp | ( | void | ) | const [virtual] |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
bool ns3::WimaxNetDevice::Send | ( | Ptr< Packet > | packet, |
const Address & | dest, | ||
uint16_t | protocolNumber | ||
) | [virtual] |
packet | packet sent from above down to Network Device |
dest | mac address of the destination (already resolved) |
protocolNumber | identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received. |
Called from higher layer to send packet into Network Device to the specified destination Address
Implements ns3::NetDevice.
References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), and GetAddress().
bool ns3::WimaxNetDevice::SendFrom | ( | Ptr< Packet > | packet, |
const Address & | source, | ||
const Address & | dest, | ||
uint16_t | protocolNumber | ||
) | [virtual] |
packet | packet sent from above down to Network Device |
source | source mac address (so called "MAC spoofing") |
dest | mac address of the destination (already resolved) |
protocolNumber | identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received. |
Called from higher layer to send packet into Network Device with the specified source and destination Addresses.
Implements ns3::NetDevice.
References ns3::Packet::AddHeader(), and ns3::Mac48Address::ConvertFrom().
void ns3::WimaxNetDevice::SetAddress | ( | Address | address | ) | [virtual] |
Set the address of this interface
address | address to set |
Implements ns3::NetDevice.
References ns3::Mac48Address::ConvertFrom().
Referenced by ns3::WimaxHelper::Install().
void ns3::WimaxNetDevice::SetBandwidthManager | ( | Ptr< BandwidthManager > | bandwidthManager | ) |
bandwidthManager | the bandwidth manager to be installed on the device |
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetBurstProfileManager | ( | Ptr< BurstProfileManager > | burstProfileManager | ) |
burstProfileManager | the burst profile manager to be installed on the device |
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetChannel | ( | Ptr< WimaxChannel > | wimaxChannel | ) |
wimaxChannel | the channel to be used |
References ns3::WimaxPhy::Attach().
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetConnectionManager | ( | Ptr< ConnectionManager > | connectionManager | ) | [virtual] |
connectionManager | the commection manager to be installed in the device |
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetIfIndex | ( | const uint32_t | index | ) | [virtual] |
index | ifIndex of the device |
Implements ns3::NetDevice.
void ns3::WimaxNetDevice::SetMacAddress | ( | Mac48Address | address | ) |
address | the mac address of the net device |
bool ns3::WimaxNetDevice::SetMtu | ( | const uint16_t | mtu | ) | [virtual] |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetNode | ( | Ptr< Node > | node | ) | [virtual] |
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
void ns3::WimaxNetDevice::SetPhy | ( | Ptr< WimaxPhy > | phy | ) |
phy | the phy layer to use. |
Referenced by GetTypeId().
void ns3::WimaxNetDevice::SetPromiscReceiveCallback | ( | PromiscReceiveCallback | cb | ) | [virtual] |
cb | callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers. |
Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means _all_ packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.
Implements ns3::NetDevice.
void ns3::WimaxNetDevice::SetReceiveCallback | ( | NetDevice::ReceiveCallback | cb | ) | [virtual] |
cb | callback to invoke whenever a packet has been received and must be forwarded to the higher layers. |
Implements ns3::NetDevice.
void ns3::WimaxNetDevice::SetRtg | ( | uint16_t | rtg | ) |
rtg | receive/transmit transition gap |
Referenced by GetTypeId(), and ns3::BaseStationNetDevice::Start().
void ns3::WimaxNetDevice::SetTtg | ( | uint16_t | ttg | ) |
ttg | transmit/receive transition gap |
Referenced by GetTypeId(), and ns3::BaseStationNetDevice::Start().
virtual void ns3::WimaxNetDevice::Start | ( | void | ) | [pure virtual] |
This method calls the virtual DoStart method on all the objects aggregated to this object. DoStart will be called only once over the lifetime of an object, just like DoDispose is called only once.
Note: the code here is a bit tricky because we need to protect ourselves from modifications in the aggregate array while DoStart is called. The user's implementation of the DoStart method could call GetObject (which could reorder the array) and it could call AggregateObject which would add an object at the end of the array. To be safe, we restart iteration over the array whenever we call some user code, just in case.
Reimplemented from ns3::Object.
Implemented in ns3::SubscriberStationNetDevice, and ns3::BaseStationNetDevice.
Referenced by ns3::WimaxHelper::Install().
bool ns3::WimaxNetDevice::SupportsSendFrom | ( | void | ) | const [virtual] |
Implements ns3::NetDevice.