ns3::LteNetDevice Class Reference

#include <lte-net-device.h>

Inheritance diagram for ns3::LteNetDevice:

Collaboration diagram for ns3::LteNetDevice:

Public Member Functions
virtual void	DoDispose (void)
void	SetPhyMacTxStartCallback (PhyMacTxStartCallback c)
	set the callback used to instruct the lower layer to start a TX
void	SetPhy (Ptr< LtePhy > phy)
Ptr< LtePhy >	GetPhy (void) const
void	SetRrcEntity (Ptr< RrcEntity > rrc)
	Set the RRC entity.
Ptr< RrcEntity >	GetRrcEntity (void)
	Get the RRC entity.
virtual void	SetIfIndex (const uint32_t index)
virtual uint32_t	GetIfIndex (void) const
virtual Ptr< Channel >	GetChannel (void) const
virtual bool	SetMtu (const uint16_t mtu)
virtual uint16_t	GetMtu (void) const
virtual void	SetAddress (Address address)
virtual Address	GetAddress (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 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 Ptr< Node >	GetNode (void) const
virtual void	SetNode (Ptr< Node > node)
virtual bool	NeedsArp (void) const
virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual Address	GetMulticast (Ipv4Address addr) 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 void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual void	Start (void)=0
	This method is called as soon as the net device is created. It can be used to start some functionalities of the considered device. For example, for the eNB device it starts the schedule of LTE Frames.
virtual void	Stop (void)=0
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 bool	SupportsSendFrom (void) const
void	Receive (Ptr< Packet > p)
	Receive the packet from the phy layer.
void	ForwardUp (Ptr< Packet > packet, const Mac48Address &source, const Mac48Address &dest)
	Forward packet to the uppar layer. If is called by DoReceive method.
void	ForwardUp (Ptr< Packet > packet)
	Forward packet to the uppar layer. If is called by DoReceive method.
void	SetPacketToSend (Ptr< PacketBurst > p)
	Set packets to send.
Ptr< PacketBurst >	GetPacketToSend (void)
	Get packets to send.
virtual void	StartTransmission (void)=0
	Start packet transmission.
virtual bool	SendPacket (Ptr< PacketBurst > p)=0
	Send packet/packets to the physical layer.
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::LteNetDevice.

Detailed Description

LteNetDevice provides basic implementation for all LTE network devices

Member Function Documentation

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

Reimplemented in ns3::EnbNetDevice, and ns3::UeNetDevice.

void ns3::LteNetDevice::ForwardUp ( Ptr< Packet > packet )

Forward packet to the uppar layer. If is called by DoReceive method.

Parameters:

packet

packet sent from Network Device to the upper layer

void ns3::LteNetDevice::ForwardUp	(	Ptr< Packet >	packet,
		const Mac48Address &	source,
		const Mac48Address &	dest
	)

Forward packet to the uppar layer. If is called by DoReceive method.

Parameters:

	packet	packet sent from Network Device to the upper layer
	source	source mac address
	dest	mac address of the destination

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

Returns:: the current Address of this interface.

Implements ns3::NetDevice.

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

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

Returns:: index ifIndex of the device

Implements ns3::NetDevice.

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

virtual Ptr<Node> ns3::LteNetDevice::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<PacketBurst> ns3::LteNetDevice::GetPacketToSend ( void )

Get packets to send.

Returns:: the pointer to the burst of packets to send

Ptr<LtePhy> ns3::LteNetDevice::GetPhy ( void ) const

Returns:: a pointer to the physical layer.

Ptr<RrcEntity> ns3::LteNetDevice::GetRrcEntity ( void )

Get the RRC entity.

Returns:: the pointer to the RRC entity

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

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

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

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

Attributes defined for this type:

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:1500
- Initial value: 1500
- Flags: construct write read
Phy: The PHY layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LtePhy >
- Initial value: 0
- Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::NetDevice.

Reimplemented in ns3::EnbNetDevice, and ns3::UeNetDevice.

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

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

Returns:: value of m_isBridge flag

Implements ns3::NetDevice.

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

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

Implements ns3::NetDevice.

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

Returns:: true if link is up; false otherwise

Implements ns3::NetDevice.

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

Returns:: value of m_isMulticast flag

Implements ns3::NetDevice.

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

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

void ns3::LteNetDevice::Receive ( Ptr< Packet > p )

Receive the packet from the phy layer.

Parameters:

p

the received packet

virtual bool ns3::LteNetDevice::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::LteNetDevice::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 bool ns3::LteNetDevice::SendPacket ( Ptr< PacketBurst > p ) [pure virtual]

Send packet/packets to the physical layer.

Parameters:

p

packet/packets to be sent

Implemented in ns3::EnbNetDevice, and ns3::UeNetDevice.

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

Set the address of this interface

Parameters:

address

address to set

Implements ns3::NetDevice.

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

Parameters:

index

ifIndex of the device

Implements ns3::NetDevice.

virtual bool ns3::LteNetDevice::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::LteNetDevice::SetNode ( Ptr< Node > node ) [virtual]

Parameters:

node

the node associated to this netdevice.

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

Implements ns3::NetDevice.

void ns3::LteNetDevice::SetPacketToSend ( Ptr< PacketBurst > p )

Set packets to send.

Parameters:

p

the burst of packets to send

void ns3::LteNetDevice::SetPhy ( Ptr< LtePhy > phy )

Parameters:

phy

the phy layer to use.

void ns3::LteNetDevice::SetPhyMacTxStartCallback ( PhyMacTxStartCallback c )

set the callback used to instruct the lower layer to start a TX

Parameters:

c

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

virtual void ns3::LteNetDevice::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::LteNetDevice::SetRrcEntity ( Ptr< RrcEntity > rrc )

Set the RRC entity.

Parameters:

rrc

the RRC entity

virtual void ns3::LteNetDevice::Stop ( void ) [pure virtual]