Net device for UAN models. More...
#include <introspected-doxygen.h>
Public Types | |
typedef std::list< Ptr< UanPhy > > | UanPhyList |
UanPhyList is defined as a standard template lib list of UanPhy objects. | |
typedef std::list< Ptr < UanTransducer > > | UanTransducerList |
UanTransducerList is a standard template lib list of UanTransducer objects. | |
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 | Clear (void) |
virtual Address | GetAddress (void) const |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual uint32_t | GetIfIndex (void) const |
Ptr< UanMac > | GetMac (void) const |
virtual uint16_t | GetMtu (void) const |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const |
Make and return a MAC multicast address using the provided multicast group. More... | |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. More... | |
virtual Ptr< Node > | GetNode (void) const |
Ptr< UanPhy > | GetPhy (void) const |
Ptr< UanTransducer > | GetTransducer (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... | |
virtual bool | NeedsArp (void) const |
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 | SetChannel (Ptr< UanChannel > channel) |
virtual void | SetIfIndex (const uint32_t index) |
void | SetMac (Ptr< UanMac > mac) |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
void | SetPhy (Ptr< UanPhy > phy) |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
void | SetSleepMode (bool sleep) |
void | SetTransducer (Ptr< UanTransducer > trans) |
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) |
Protected Member Functions | |
virtual void | DoDispose () |
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) |
Private Member Functions | |
Ptr< UanChannel > | DoGetChannel (void) const |
virtual void | ForwardUp (Ptr< Packet > pkt, const UanAddress &src) |
Private Attributes | |
Ptr< UanChannel > | m_channel |
bool | m_cleared |
ReceiveCallback | m_forwardUp |
uint32_t | m_ifIndex |
TracedCallback | m_linkChanges |
bool | m_linkup |
Ptr< UanMac > | m_mac |
uint16_t | m_mtu |
std::string | m_name |
Ptr< Node > | m_node |
Ptr< UanPhy > | m_phy |
TracedCallback< Ptr< const Packet >, UanAddress > | m_rxLogger |
Ptr< UanTransducer > | m_trans |
TracedCallback< Ptr< const Packet >, UanAddress > | m_txLogger |
Net device for UAN models.
ns3::UanNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Definition at line 48 of file uan-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 366 of file uan-net-device.cc.
References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext().
void ns3::UanNetDevice::Clear | ( | void | ) |
Clears all pointer references
Definition at line 51 of file uan-net-device.cc.
Referenced by DoDispose().
|
protectedvirtual |
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.
Definition at line 82 of file uan-net-device.cc.
References Clear(), and ns3::Object::DoDispose().
|
virtual |
Implements ns3::NetDevice.
Definition at line 221 of file uan-net-device.cc.
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 254 of file uan-net-device.cc.
Implements ns3::NetDevice.
Definition at line 215 of file uan-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 209 of file uan-net-device.cc.
Definition at line 191 of file uan-net-device.cc.
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 236 of file uan-net-device.cc.
|
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 266 of file uan-net-device.cc.
References NS_FATAL_ERROR.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 273 of file uan-net-device.cc.
References NS_FATAL_ERROR.
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 304 of file uan-net-device.cc.
Definition at line 197 of file uan-net-device.cc.
Ptr< UanTransducer > ns3::UanNetDevice::GetTransducer | ( | void | ) | const |
Definition at line 337 of file uan-net-device.cc.
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 280 of file uan-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 248 of file uan-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 242 of file uan-net-device.cc.
|
virtual |
Implements ns3::NetDevice.
Definition at line 260 of file uan-net-device.cc.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 285 of file uan-net-device.cc.
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 316 of file uan-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 291 of file uan-net-device.cc.
|
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 297 of file uan-net-device.cc.
References NS_ASSERT_MSG.
|
virtual |
Set the address of this interface
address | address to set |
Implements ns3::NetDevice.
Definition at line 386 of file uan-net-device.cc.
References ns3::UanAddress::ConvertFrom(), and NS_ASSERT_MSG.
void ns3::UanNetDevice::SetChannel | ( | Ptr< UanChannel > | channel | ) |
channel | The channel this device is attached to |
Definition at line 163 of file uan-net-device.cc.
References NS_LOG_DEBUG.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 203 of file uan-net-device.cc.
mac | Set MAC layer for this device |
Definition at line 121 of file uan-net-device.cc.
References ns3::MakeCallback(), and NS_LOG_DEBUG.
|
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 227 of file uan-net-device.cc.
References NS_LOG_WARN.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 310 of file uan-net-device.cc.
phy | Set PHY layer for this device |
Definition at line 140 of file uan-net-device.cc.
References NS_LOG_DEBUG.
|
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 373 of file uan-net-device.cc.
References NS_ASSERT_MSG.
|
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 322 of file uan-net-device.cc.
void ns3::UanNetDevice::SetTransducer | ( | Ptr< UanTransducer > | trans | ) |
trans | Transducer to use in this net device |
Definition at line 342 of file uan-net-device.cc.
References NS_LOG_DEBUG.
|
virtual |
Implements ns3::NetDevice.
Definition at line 380 of file uan-net-device.cc.