ns3::SimpleNetDevice Class Reference
[NetDevice]

simple net device for simple things and testing More...

#include <simple-net-device.h>

Inheritance diagram for ns3::SimpleNetDevice:
Inheritance graph
[legend]
Collaboration diagram for ns3::SimpleNetDevice:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SimpleNetDevice ()
void Receive (Ptr< Packet > packet, uint16_t protocol, Mac48Address to, Mac48Address from)
void SetChannel (Ptr< SimpleChannel > channel)
void SetAddress (Mac48Address address)
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< ChannelGetChannel (void) const
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 (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group.
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link.
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge.
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 Ptr< NodeGetNode (void) const
virtual void SetNode (Ptr< Node > node)
virtual bool NeedsArp (void) const
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided.
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual bool SupportsSendFrom (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::NetDevice.

Protected Member Functions

virtual void DoDispose (void)

Private Attributes

Ptr< SimpleChannelm_channel
NetDevice::ReceiveCallback m_rxCallback
NetDevice::PromiscReceiveCallback m_promiscCallback
Ptr< Nodem_node
uint16_t m_mtu
std::string m_name
uint32_t m_ifIndex
Mac48Address m_address

Detailed Description

simple net device for simple things and testing

Definition at line 38 of file simple-net-device.h.


Constructor & Destructor Documentation

ns3::SimpleNetDevice::SimpleNetDevice (  ) 

Definition at line 37 of file simple-net-device.cc.


Member Function Documentation

void ns3::SimpleNetDevice::DoDispose ( void   )  [protected, 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.

Reimplemented from ns3::Object.

Definition at line 211 of file simple-net-device.cc.

References m_channel, and m_node.

Address ns3::SimpleNetDevice::GetAddress ( void   )  const [virtual]
Returns:
the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 112 of file simple-net-device.cc.

References m_address.

Address ns3::SimpleNetDevice::GetBroadcast ( void   )  const [virtual]
Returns:
the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

Definition at line 141 of file simple-net-device.cc.

Ptr< Channel > ns3::SimpleNetDevice::GetChannel ( void   )  const [virtual]
Returns:
the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel.

Implements ns3::NetDevice.

Definition at line 107 of file simple-net-device.cc.

References m_channel.

uint32_t ns3::SimpleNetDevice::GetIfIndex ( void   )  const [virtual]
Returns:
index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 102 of file simple-net-device.cc.

References m_ifIndex.

uint16_t ns3::SimpleNetDevice::GetMtu ( void   )  const [virtual]
Returns:
the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implements ns3::NetDevice.

Definition at line 123 of file simple-net-device.cc.

References m_mtu.

Address ns3::SimpleNetDevice::GetMulticast ( Ipv6Address  addr  )  const [virtual]

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters:
addr IPv6 address
Returns:
the MAC multicast address
Warning:
Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

Definition at line 156 of file simple-net-device.cc.

References GetMulticast().

Address ns3::SimpleNetDevice::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.

A default imlementation of GetMulticast is provided, but this method simply NS_ASSERTS. 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.

Parameters:
multicastGroup The IP address for the multicast group destination of the packet.
Returns:
The MAC multicast Address used to send packets to the provided multicast group.
Warning:
Calling this method is invalid if IsMulticast returns not true.
See also:
Ipv4Address
Address
NetDevice::IsMulticast

Implements ns3::NetDevice.

Definition at line 151 of file simple-net-device.cc.

Referenced by GetMulticast().

std::string ns3::SimpleNetDevice::GetName ( void   )  const [virtual]
Returns:
name name of the device (e.g. "eth0")

Implements ns3::NetDevice.

Definition at line 92 of file simple-net-device.cc.

References m_name.

Ptr< Node > ns3::SimpleNetDevice::GetNode ( void   )  const [virtual]
Returns:
the node base class which contains this network interface.

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 190 of file simple-net-device.cc.

References m_node.

TypeId ns3::SimpleNetDevice::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::NetDevice.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]

Attributes defined for this type:

  • Mtu: The MAC-level Maximum Transmission Unit

No TraceSources defined for this type.

Reimplemented from ns3::NetDevice.

Definition at line 28 of file simple-net-device.cc.

References ns3::TypeId::SetParent().

bool ns3::SimpleNetDevice::IsBridge ( void   )  const [virtual]

Return true if the net device is acting as a bridge.

Returns:
value of m_isBridge flag

Implements ns3::NetDevice.

Definition at line 168 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::IsBroadcast ( void   )  const [virtual]
Returns:
true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

Definition at line 136 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::IsLinkUp ( void   )  const [virtual]
Returns:
true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 128 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::IsMulticast ( void   )  const [virtual]
Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 146 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::IsPointToPoint ( void   )  const [virtual]

Return true if the net device is on a point-to-point link.

Returns:
value of m_isPointToPoint flag

Implements ns3::NetDevice.

Definition at line 162 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::NeedsArp ( void   )  const [virtual]
Returns:
true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implements ns3::NetDevice.

Definition at line 200 of file simple-net-device.cc.

void ns3::SimpleNetDevice::Receive ( Ptr< Packet packet,
uint16_t  protocol,
Mac48Address  to,
Mac48Address  from 
)
bool ns3::SimpleNetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
) [virtual]
Parameters:
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

Returns:
whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 174 of file simple-net-device.cc.

References ns3::Mac48Address::ConvertFrom(), m_address, and m_channel.

bool ns3::SimpleNetDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
) [virtual]
Parameters:
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.

Returns:
whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 181 of file simple-net-device.cc.

References ns3::Mac48Address::ConvertFrom(), and m_channel.

void ns3::SimpleNetDevice::SetAddress ( Mac48Address  address  ) 

Definition at line 81 of file simple-net-device.cc.

References m_address.

void ns3::SimpleNetDevice::SetChannel ( Ptr< SimpleChannel channel  ) 

Definition at line 74 of file simple-net-device.cc.

References m_channel.

void ns3::SimpleNetDevice::SetIfIndex ( const uint32_t  index  )  [virtual]
Parameters:
index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 97 of file simple-net-device.cc.

References m_ifIndex.

void ns3::SimpleNetDevice::SetLinkChangeCallback ( Callback< void >  callback  )  [virtual]
Parameters:
callback the callback to invoke

Register 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 whenever the link goes up.

Implements ns3::NetDevice.

Definition at line 133 of file simple-net-device.cc.

bool ns3::SimpleNetDevice::SetMtu ( const uint16_t  mtu  )  [virtual]
Parameters:
mtu MTU value, in bytes, to set for the device
Returns:
whether the MTU value was within legal bounds

Override for default MTU defined on a per-type basis.

Implements ns3::NetDevice.

Definition at line 117 of file simple-net-device.cc.

References m_mtu.

void ns3::SimpleNetDevice::SetName ( const std::string  name  )  [virtual]
Parameters:
name name of the device (e.g. "eth0")

Implements ns3::NetDevice.

Definition at line 87 of file simple-net-device.cc.

References m_name.

void ns3::SimpleNetDevice::SetNode ( Ptr< Node node  )  [virtual]
Parameters:
node the node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implements ns3::NetDevice.

Definition at line 195 of file simple-net-device.cc.

References m_node.

void ns3::SimpleNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback  cb  )  [virtual]
Parameters:
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 220 of file simple-net-device.cc.

References m_promiscCallback.

void ns3::SimpleNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb  )  [virtual]
Parameters:
cb callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Implements ns3::NetDevice.

Definition at line 205 of file simple-net-device.cc.

References m_rxCallback.

bool ns3::SimpleNetDevice::SupportsSendFrom ( void   )  const [virtual]
Returns:
true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

Definition at line 226 of file simple-net-device.cc.


Member Data Documentation

Definition at line 87 of file simple-net-device.h.

Referenced by GetAddress(), Receive(), Send(), and SetAddress().

Definition at line 80 of file simple-net-device.h.

Referenced by DoDispose(), GetChannel(), Send(), SendFrom(), and SetChannel().

uint32_t ns3::SimpleNetDevice::m_ifIndex [private]

Definition at line 86 of file simple-net-device.h.

Referenced by GetIfIndex(), and SetIfIndex().

uint16_t ns3::SimpleNetDevice::m_mtu [private]

Definition at line 84 of file simple-net-device.h.

Referenced by GetMtu(), and SetMtu().

std::string ns3::SimpleNetDevice::m_name [private]

Definition at line 85 of file simple-net-device.h.

Referenced by GetName(), and SetName().

Definition at line 83 of file simple-net-device.h.

Referenced by DoDispose(), GetNode(), and SetNode().

Definition at line 82 of file simple-net-device.h.

Referenced by Receive(), and SetPromiscReceiveCallback().

Definition at line 81 of file simple-net-device.h.

Referenced by Receive(), and SetReceiveCallback().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:12:07 2009 for NS-3 by  doxygen 1.6.3