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 Types inherited from ns3::NetDevice | |
enum | PacketType { PACKET_HOST = 1, NS3_PACKET_HOST = PACKET_HOST, PACKET_BROADCAST, NS3_PACKET_BROADCAST = PACKET_BROADCAST, PACKET_MULTICAST, NS3_PACKET_MULTICAST = PACKET_MULTICAST, PACKET_OTHERHOST, NS3_PACKET_OTHERHOST = PACKET_OTHERHOST } |
typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
Public Member Functions | |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
void | Attach (Ptr< WimaxChannel > channel) |
void | CreateDefaultConnections (void) |
virtual void | DoDispose (void) |
virtual bool | Enqueue (Ptr< Packet > packet, const MacHeaderType &hdrType, Ptr< WimaxConnection > connection)=0 |
void | ForwardDown (Ptr< PacketBurst > burst, WimaxPhy::ModulationType modulationType) |
void | ForwardUp (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest) |
virtual Address | GetAddress (void) const |
Ptr< BandwidthManager > | GetBandwidthManager (void) const |
virtual Address | GetBroadcast (void) const |
Ptr< WimaxConnection > | GetBroadcastConnection (void) const |
Ptr< BurstProfileManager > | GetBurstProfileManager (void) const |
uint64_t | GetChannel (uint8_t index) const |
virtual Ptr< Channel > | GetChannel (void) const |
Ptr< ConnectionManager > | GetConnectionManager (void) const |
Dcd | GetCurrentDcd (void) const |
Ucd | GetCurrentUcd (void) const |
virtual uint32_t | GetIfIndex (void) const |
Ptr< WimaxConnection > | GetInitialRangingConnection (void) const |
Mac48Address | GetMacAddress (void) const |
virtual uint16_t | GetMtu (void) const |
virtual Address | GetMulticast (void) const |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. More... | |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. More... | |
virtual std::string | GetName (void) const |
virtual Ptr< Node > | GetNode (void) const |
uint32_t | GetNrFrames (void) const |
Ptr< WimaxPhy > | GetPhy (void) const |
virtual Ptr< Channel > | GetPhyChannel (void) const |
NetDevice::PromiscReceiveCallback | GetPromiscReceiveCallback (void) |
uint16_t | GetRtg (void) const |
uint8_t | GetState (void) const |
uint16_t | GetTtg (void) const |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. More... | |
virtual bool | IsBroadcast (void) const |
virtual bool | IsLinkUp (void) const |
virtual bool | IsMulticast (void) const |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. More... | |
bool | IsPromisc (void) |
virtual Address | MakeMulticastAddress (Ipv4Address multicastGroup) const |
virtual bool | NeedsArp (void) const |
void | NotifyPromiscTrace (Ptr< Packet > p) |
virtual bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) |
virtual bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) |
virtual void | SetAddress (Address address) |
void | SetBandwidthManager (Ptr< BandwidthManager > bandwidthManager) |
void | SetBurstProfileManager (Ptr< BurstProfileManager > burstProfileManager) |
void | SetChannel (Ptr< WimaxChannel > wimaxChannel) |
virtual void | SetConnectionManager (Ptr< ConnectionManager > connectionManager) |
void | SetCurrentDcd (Dcd dcd) |
void | SetCurrentUcd (Ucd ucd) |
virtual void | SetIfIndex (const uint32_t index) |
virtual void | SetLinkChangeCallback (Callback< void > callback) |
void | SetMacAddress (Mac48Address address) |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetName (const std::string name) |
virtual void | SetNode (Ptr< Node > node) |
void | SetNrFrames (uint32_t nrFrames) |
void | SetPhy (Ptr< WimaxPhy > phy) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
void | SetReceiveCallback (void) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
void | SetRtg (uint16_t rtg) |
void | SetState (uint8_t state) |
void | SetTtg (uint16_t ttg) |
virtual void | Start (void)=0 |
virtual void | Stop (void)=0 |
virtual bool | SupportsSendFrom (void) const |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
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) |
Private Member Functions | |
WimaxNetDevice (const WimaxNetDevice &) | |
virtual Ptr< WimaxChannel > | DoGetChannel (void) const |
virtual void | DoReceive (Ptr< Packet > packet)=0 |
virtual bool | DoSend (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest, uint16_t protocolNumber)=0 |
void | InitializeChannels (void) |
WimaxNetDevice & | operator= (const WimaxNetDevice &) |
void | Receive (Ptr< const PacketBurst > burst) |
Private Attributes | |
Mac48Address | m_address |
Ptr< BandwidthManager > | m_bandwidthManager |
Ptr< WimaxConnection > | m_broadcastConnection |
Ptr< BurstProfileManager > | m_burstProfileManager |
Ptr< ConnectionManager > | m_connectionManager |
Dcd | m_currentDcd |
Ucd | m_currentUcd |
std::vector< uint64_t > | m_dlChannels |
NetDevice::ReceiveCallback | m_forwardUp |
uint32_t | m_ifIndex |
Ptr< WimaxConnection > | m_initialRangingConnection |
Callback< void > | m_linkChange |
bool | m_linkUp |
Ptr< Object > | m_mobility |
uint16_t | m_mtu |
std::string | m_name |
Ptr< Node > | m_node |
Ptr< WimaxPhy > | m_phy |
NetDevice::PromiscReceiveCallback | m_promiscRx |
uint16_t | m_rtg |
uint8_t | m_state |
uint32_t | m_symbolIndex |
uint16_t | m_ttg |
Static Private Attributes | |
static const uint16_t | DEFAULT_MSDU_SIZE = 1400 |
static uint32_t | m_nrFrames = 0 |
static const uint16_t | MAX_MSDU_SIZE = 1500 |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
Hold together all Wimax-related objects in a NetDevice.
This class holds together ns3::WimaxPhy, ns3::WimaxConnection, ns3::ConectionManager, ns3::BurstProfileManager, and ns3::BandwidthManager.
ns3::WimaxNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Definition at line 69 of file wimax-net-device.h.
|
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.
Definition at line 634 of file wimax-net-device.cc.
References NS_FATAL_ERROR.
|
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.
Reimplemented in ns3::SubscriberStationNetDevice, and ns3::BaseStationNetDevice.
Definition at line 149 of file wimax-net-device.cc.
References ns3::Object::DoDispose().
Referenced by ns3::BaseStationNetDevice::DoDispose(), and ns3::SubscriberStationNetDevice::DoDispose().
|
virtual |
Implements ns3::NetDevice.
Definition at line 406 of file wimax-net-device.cc.
Referenced by Send().
Ptr< BandwidthManager > ns3::WimaxNetDevice::GetBandwidthManager | ( | void | ) | const |
Definition at line 490 of file wimax-net-device.cc.
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 265 of file wimax-net-device.cc.
References ns3::Mac48Address::GetBroadcast().
Ptr< WimaxConnection > ns3::WimaxNetDevice::GetBroadcastConnection | ( | void | ) | const |
Definition at line 436 of file wimax-net-device.cc.
Referenced by ns3::BaseStationNetDevice::CreateDescriptorMessages(), and ns3::BaseStationNetDevice::CreateMapMessages().
Ptr< BurstProfileManager > ns3::WimaxNetDevice::GetBurstProfileManager | ( | void | ) | const |
Definition at line 478 of file wimax-net-device.cc.
Referenced by ns3::SubscriberStationNetDevice::SendBurst().
Implements ns3::NetDevice.
Definition at line 216 of file wimax-net-device.cc.
Ptr< ConnectionManager > ns3::WimaxNetDevice::GetConnectionManager | ( | void | ) | const |
Definition at line 466 of file wimax-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 210 of file wimax-net-device.cc.
Ptr< WimaxConnection > ns3::WimaxNetDevice::GetInitialRangingConnection | ( | void | ) | const |
Definition at line 430 of file wimax-net-device.cc.
Mac48Address ns3::WimaxNetDevice::GetMacAddress | ( | void | ) | const |
Definition at line 412 of file wimax-net-device.cc.
Referenced by ns3::SubscriberStationNetDevice::SendBurst().
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 239 of file wimax-net-device.cc.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 625 of file wimax-net-device.cc.
References ns3::Mac48Address::GetMulticast(), and NS_LOG_LOGIC.
|
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.
Definition at line 608 of file wimax-net-device.cc.
References ns3::Mac48Address::GetMulticast(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
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.
Definition at line 315 of file wimax-net-device.cc.
Definition at line 360 of file wimax-net-device.cc.
uint16_t ns3::WimaxNetDevice::GetRtg | ( | void | ) | const |
Definition at line 186 of file wimax-net-device.cc.
uint16_t ns3::WimaxNetDevice::GetTtg | ( | void | ) | const |
Definition at line 174 of file wimax-net-device.cc.
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 601 of file wimax-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
virtual |
Implements ns3::NetDevice.
Definition at line 259 of file wimax-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 245 of file wimax-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 271 of file wimax-net-device.cc.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 289 of file wimax-net-device.cc.
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 321 of file wimax-net-device.cc.
|
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.
Definition at line 295 of file wimax-net-device.cc.
References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), and GetAddress().
|
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.
Definition at line 535 of file wimax-net-device.cc.
References ns3::Packet::AddHeader(), and ns3::Mac48Address::ConvertFrom().
|
virtual |
Set the address of this interface
address | address to set |
Implements ns3::NetDevice.
Definition at line 394 of file wimax-net-device.cc.
References ns3::Mac48Address::ConvertFrom().
void ns3::WimaxNetDevice::SetBandwidthManager | ( | Ptr< BandwidthManager > | bandwidthManager | ) |
bandwidthManager | the bandwidth manager to be installed on the device |
Definition at line 496 of file wimax-net-device.cc.
void ns3::WimaxNetDevice::SetBurstProfileManager | ( | Ptr< BurstProfileManager > | burstProfileManager | ) |
burstProfileManager | the burst profile manager to be installed on the device |
Definition at line 484 of file wimax-net-device.cc.
void ns3::WimaxNetDevice::SetChannel | ( | Ptr< WimaxChannel > | wimaxChannel | ) |
wimaxChannel | the channel to be used |
Definition at line 366 of file wimax-net-device.cc.
|
virtual |
connectionManager | the commection manager to be installed in the device |
Definition at line 472 of file wimax-net-device.cc.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 204 of file wimax-net-device.cc.
void ns3::WimaxNetDevice::SetMacAddress | ( | Mac48Address | address | ) |
address | the mac address of the net device |
Definition at line 400 of file wimax-net-device.cc.
|
virtual |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Definition at line 228 of file wimax-net-device.cc.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 309 of file wimax-net-device.cc.
phy | the phy layer to use. |
Definition at line 354 of file wimax-net-device.cc.
|
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.
Definition at line 550 of file wimax-net-device.cc.
|
virtual |
cb | callback to invoke whenever a packet has been received and must be forwarded to the higher layers. |
Implements ns3::NetDevice.
Definition at line 333 of file wimax-net-device.cc.
void ns3::WimaxNetDevice::SetRtg | ( | uint16_t | rtg | ) |
rtg | receive/transmit transition gap |
Definition at line 180 of file wimax-net-device.cc.
void ns3::WimaxNetDevice::SetTtg | ( | uint16_t | ttg | ) |
ttg | transmit/receive transition gap |
Definition at line 168 of file wimax-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 568 of file wimax-net-device.cc.