ns3::EmuNetDevice Class Reference

A Device for an Emu Network Link. More...

#include <emu-net-device.h>

Inheritance diagram for ns3::EmuNetDevice:

[legend]

Collaboration diagram for ns3::EmuNetDevice:

[legend]

List of all members.

Public Types
enum	EncapsulationMode { ILLEGAL, DIX, LLC }
Public Member Functions
	EmuNetDevice ()
virtual	~EmuNetDevice ()
void	SetDataRate (DataRate bps)
void	Start (Time tStart)
void	Stop (Time tStop)
void	SetQueue (Ptr< Queue > queue)
Ptr< Queue >	GetQueue (void) const
virtual void	SetIfIndex (const uint32_t index)
virtual uint32_t	GetIfIndex (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	AddLinkChangeCallback (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 Address	GetMulticast (Ipv6Address addr) const
	Get the MAC multicast address corresponding to the IPv6 address provided.
virtual bool	IsPointToPoint (void) const
virtual bool	IsBridge (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 Ptr< Node >	GetNode (void) const
virtual void	SetNode (Ptr< Node > node)
virtual bool	NeedsArp (void) const
virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual bool	SupportsSendFrom (void) const
void	SetEncapsulationMode (EmuNetDevice::EncapsulationMode mode)
EmuNetDevice::EncapsulationMode	GetEncapsulationMode (void) const
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::EmuNetDevice.

Detailed Description

A Device for an Emu Network Link.

Member Enumeration Documentation

enum ns3::EmuNetDevice::EncapsulationMode

Enumeration of the types of packets supported in the class.

Enumerator:

ILLEGAL	Encapsulation mode not set
DIX	DIX II / Ethernet II packet
LLC	802.2 LLC/SNAP Packet

Constructor & Destructor Documentation

ns3::EmuNetDevice::EmuNetDevice ( )

Construct a EmuNetDevice

This is the constructor for the EmuNetDevice. It takes as a

virtual ns3::EmuNetDevice::~EmuNetDevice ( ) [virtual]

Destroy a EmuNetDevice

This is the destructor for the EmuNetDevice.

Member Function Documentation

virtual void ns3::EmuNetDevice::AddLinkChangeCallback ( Callback< void > callback ) [virtual]

Parameters:

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.

virtual Address ns3::EmuNetDevice::GetAddress ( void ) const [virtual]

Returns:: the current Address of this interface.

Implements ns3::NetDevice.

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

virtual Ptr<Channel> ns3::EmuNetDevice::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 or if the underlying NetDevice has no concept of a channel. i.e., callers _must_ check for zero and be ready to handle it.

Implements ns3::NetDevice.

EmuNetDevice::EncapsulationMode ns3::EmuNetDevice::GetEncapsulationMode ( void ) const

Get the encapsulation mode of this device.

Returns:: The encapsulation mode of this device.

virtual uint32_t ns3::EmuNetDevice::GetIfIndex ( void ) const [virtual]

Returns:: index ifIndex of the device

Implements ns3::NetDevice.

virtual uint16_t ns3::EmuNetDevice::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.

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

virtual Address ns3::EmuNetDevice::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).

This method performs the multicast address creation function appropriate to an EUI-48-based CSMA device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact address format.

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.

See also:: Ipv4Address; Mac48Address; Address

Implements ns3::NetDevice.

virtual Ptr<Node> ns3::EmuNetDevice::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.

Ptr<Queue> ns3::EmuNetDevice::GetQueue ( void ) const

Get a copy of the attached Queue.

Returns:: Ptr to the queue.

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

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

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

/NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::EmuNetDevice
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::EmuNetDevice

Attributes defined for this type:

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Flags: read
Address: The ns-3 MAC address of this (virtual) device.
- Set with class: Mac48AddressValue
- Underlying type: Mac48Address
- Initial value: ff:ff:ff:ff:ff:ff
- Flags: construct write read
DeviceName: The name of the underlying real device (e.g. eth1).
- Set with class: StringValue
- Underlying type: std::string
- Initial value: eth1
- Flags: construct write read
Start: The simulation time at which to spin up the device thread.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: 0ns
- Flags: construct write read
Stop: The simulation time at which to tear down the device thread.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: 0ns
- Flags: construct write read
EncapsulationMode: The link-layer encapsulation type to use.
- Set with class: ns3::EnumValue
- Underlying type: Dix|Llc
- Initial value: Dix
- Flags: construct write
TxQueue: A queue to use as the transmit queue in the device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Queue >
- Initial value: 0
- Flags: construct write read
RxQueueSize: Maximum size of the read queue. This value limits number of packets that have been read from the network into a memory buffer but have not yet been processed by the simulator.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1000
- Flags: construct write read

TraceSources defined for this type:

MacTx: Trace source indicating a packet has arrived for transmission by this device
MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

Reimplemented from ns3::NetDevice.

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

Is this a bridge?

Returns:: false.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsBroadcast ( void ) const [virtual]

Returns:: true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsLinkUp ( void ) const [virtual]

Returns:: true if link is up; false otherwise

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::IsMulticast ( void ) const [virtual]

Returns:: value of m_isMulticast flag

Implements ns3::NetDevice.

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

Is this a point to point link?

Returns:: false.

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::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.

virtual bool ns3::EmuNetDevice::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.

virtual bool ns3::EmuNetDevice::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.

virtual void ns3::EmuNetDevice::SetAddress ( Address address ) [virtual]

Set the address of this interface

Parameters:

address

address to set

Implements ns3::NetDevice.

void ns3::EmuNetDevice::SetDataRate ( DataRate bps )

Set the Data Rate used for transmission of packets.

See also:: Attach ()

Parameters:

bps

the data rate at which this object operates

void ns3::EmuNetDevice::SetEncapsulationMode ( EmuNetDevice::EncapsulationMode mode )

Set the encapsulation mode of this device.

Parameters:

mode

The encapsulation mode of this device.

See also:: SetFrameSize

virtual void ns3::EmuNetDevice::SetIfIndex ( const uint32_t index ) [virtual]

Parameters:

index

ifIndex of the device

Implements ns3::NetDevice.

virtual bool ns3::EmuNetDevice::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.

virtual void ns3::EmuNetDevice::SetNode ( Ptr< Node > node ) [virtual]

Parameters:

node

the node associated to this netdevice.

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

Implements ns3::NetDevice.

virtual void ns3::EmuNetDevice::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.

void ns3::EmuNetDevice::SetQueue ( Ptr< Queue > queue )

Attach a queue to the EmuNetDevice.

The EmuNetDevice "owns" a queue that implements a queueing method such as DropTail or RED.

See also:: Queue; DropTailQueue

Parameters:

queue

Ptr to the new queue.

virtual void ns3::EmuNetDevice::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.

void ns3::EmuNetDevice::Start ( Time tStart )

Set a start time for the device.

Parameters:

tStart

the start time

void ns3::EmuNetDevice::Stop ( Time tStop )

Set a stop time for the device.

Parameters:

tStop

the stop time

virtual bool ns3::EmuNetDevice::SupportsSendFrom ( void ) const [virtual]

Returns:: true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

The documentation for this class was generated from the following files:

src/devices/emu/emu-net-device.h
doc/introspected-doxygen.h

ns3::EmuNetDevice Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation