Shim performing 6LoWPAN compression, decompression and fragmentation. More...

#include <sixlowpan-net-device.h>

Inheritance diagram for ns3::SixLowPanNetDevice:

Collaboration diagram for ns3::SixLowPanNetDevice:

Classes
class	Fragments
	A Set of Fragment. More...

Public Types
enum	DropReason { DROP_FRAGMENT_TIMEOUT = 1, DROP_FRAGMENT_BUFFER_FULL, DROP_UNKNOWN_EXTENSION }
	Enumeration of the dropping reasons in SixLoWPAN. More...

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 }
	Packet types are used as they are in Linux. More...

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
	SixLowPanNetDevice ()
	Constructor for the SixLowPanNetDevice. More...

virtual void	AddLinkChangeCallback (Callback< void > callback)

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

virtual Address	GetAddress (void) const

virtual Address	GetBroadcast (void) const

virtual Ptr< Channel >	GetChannel (void) const

virtual uint32_t	GetIfIndex (void) const

virtual uint16_t	GetMtu (void) const
	Returns the link-layer MTU for this interface. More...

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...

Ptr< NetDevice >	GetNetDevice () const
	Returns a smart pointer to the underlying NetDevice. More...

virtual Ptr< Node >	GetNode (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)
	Set the address of this interface. More...

virtual void	SetIfIndex (const uint32_t index)

virtual bool	SetMtu (const uint16_t mtu)

void	SetNetDevice (Ptr< NetDevice > device)
	Setup SixLowPan to be a proxy for the specified NetDevice. More...

virtual void	SetNode (Ptr< Node > node)

virtual void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

virtual bool	SupportsSendFrom () const

Public Member Functions inherited from ns3::NetDevice
virtual	~NetDevice ()

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::NetDevice
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Private Types
typedef std::pair< std::pair < Address, Address > , std::pair< uint16_t, uint16_t > >	FragmentKey
	Fragment identifier type: src/dst address src/dst port. More...

typedef std::map< FragmentKey, Ptr< Fragments > >	MapFragments_t
	Container for fragment key -> fragments. More...

typedef std::map< FragmentKey, Ptr< Fragments > >::iterator	MapFragmentsI_t
	Container Iterator for fragment key -> fragments. More...

typedef std::map< FragmentKey, EventId >	MapFragmentsTimers_t
	Container for fragment key -> exiration event. More...

typedef std::map< FragmentKey, EventId >::iterator	MapFragmentsTimersI_t
	Container Iterator for fragment key -> exiration event. More...

Private Member Functions
	SixLowPanNetDevice (SixLowPanNetDevice const &)
	Copy constructor. More...

bool	CanCompressLowPanNhc (uint8_t headerType)
	Checks if the next header can be compressed using NHC. More...

uint32_t	CompressLowPanHc1 (Ptr< Packet > packet, Address const &src, Address const &dst)
	Compress the headers according to HC1 compression. More...

uint32_t	CompressLowPanIphc (Ptr< Packet > packet, Address const &src, Address const &dst)
	Compress the headers according to IPHC compression. More...

uint32_t	CompressLowPanNhc (Ptr< Packet > packet, uint8_t headerType, Address const &src, Address const &dst)
	Compress the headers according to NHC compression. More...

uint32_t	CompressLowPanUdpNhc (Ptr< Packet > packet, bool omitChecksum)
	Compress the headers according to NHC compression. More...

void	DecompressLowPanHc1 (Ptr< Packet > packet, Address const &src, Address const &dst)
	Decompress the headers according to HC1 compression. More...

void	DecompressLowPanIphc (Ptr< Packet > packet, Address const &src, Address const &dst)
	Decompress the headers according to IPHC compression. More...

uint8_t	DecompressLowPanNhc (Ptr< Packet > packet, Address const &src, Address const &dst, Ipv6Address srcAddress, Ipv6Address dstAddress)
	Decompress the headers according to NHC compression. More...

void	DecompressLowPanUdpNhc (Ptr< Packet > packet, Ipv6Address saddr, Ipv6Address daddr)
	Decompress the headers according to NHC compression. More...

void	DoFragmentation (Ptr< Packet > packet, uint32_t origPacketSize, uint32_t origHdrSize, std::list< Ptr< Packet > > &listFragments)
	Return the instance type identifier. More...

void	DropOldestFragmentSet ()
	Drops the oldest fragment set. More...

void	HandleFragmentsTimeout (FragmentKey key, uint32_t iif)
	Process the timeout for packet fragments. More...

Ipv6Address	MakeGlobalAddressFromMac (Address const &addr, Ipv6Address prefix)
	make a global address from a MAC address. More...

Ipv6Address	MakeLinkLocalAddressFromMac (Address const &addr)
	make a link-local address from a MAC address. More...

SixLowPanNetDevice &	operator= (SixLowPanNetDevice const &)
	Copy constructor. More...

bool	ProcessFragment (Ptr< Packet > &packet, Address const &src, Address const &dst, bool isFirst)
	Process a packet fragment. More...

void	ReceiveFromDevice (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, Address const &source, Address const &destination, PacketType packetType)
	receives all the packets from a NetDevice for further processing. More...

Private Attributes
TracedCallback< DropReason, Ptr< const Packet >, Ptr < SixLowPanNetDevice > , uint32_t >	m_dropTrace
	Callback to trace drop packets. More...

uint16_t	m_etherType
	EtherType number (used only if m_forceEtherType is true) More...

bool	m_forceEtherType
	Force the EtherType number. More...

Time	m_fragmentExpirationTimeout
	Time limit for fragment rebuilding. More...

uint16_t	m_fragmentReassemblyListSize
	How many packets can be rebuilt at the same time. More...

MapFragments_t	m_fragments
	Fragments hold to be rebuilt. More...

MapFragmentsTimers_t	m_fragmentsTimers
	Timers related to fragment rebuilding. More...

uint32_t	m_ifIndex
	Interface index. More...

Ptr< NetDevice >	m_netDevice
	Smart pointer to the underlying NetDevice. More...

Ptr< Node >	m_node
	Smart pointer to the Node. More...

bool	m_omitUdpChecksum
	Omit UDP checksum in NC1 encoding. More...

NetDevice::PromiscReceiveCallback	m_promiscRxCallback
	The callback used to notify higher layers that a packet has been received in promiscuous mode. More...

Ptr< UniformRandomVariable >	m_rng
	Rng for the fragments tag. More...

NetDevice::ReceiveCallback	m_rxCallback
	The callback used to notify higher layers that a packet has been received. More...

TracedCallback< Ptr< const Packet >, Ptr < SixLowPanNetDevice > , uint32_t >	m_rxTrace
	Callback to trace RX (reception) packets. More...

TracedCallback< Ptr< const Packet >, Ptr < SixLowPanNetDevice > , uint32_t >	m_txTrace
	Callback to trace TX (transmission) packets. More...

bool	m_useIphc
	Use IPHC or HC1. More...

Detailed Description

Shim performing 6LoWPAN compression, decompression and fragmentation.

This class implements the shim between IPv6 and a generic NetDevice, performing packet compression, decompression and fragmentation in a transparent way. To this end, the class pretend to be a normal NetDevice, masquerading some functions of the underlying NetDevice.

Config Paths

ns3::SixLowPanNetDevice is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::SixLowPanNetDevice

Attributes

Rfc6282: Use RFC6282 (IPHC) if true, RFC4944 (HC1) otherwise.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
OmitUdpChecksum: Omit the UDP checksum in IPHC compression.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
FragmentReassemblyListSize: The maximum size of the reassembly buffer (in packets). Zero meaning infinite.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: construct write read
FragmentExpirationTimeout: When this timeout expires, the fragments will be cleared from the buffer.
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +60000000000.0ns
- Flags: construct write read
ForceEtherType: Force a specific EtherType in L2 frames.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
EtherType: The specific EtherType to be used in L2 frames.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 65535
- Flags: construct write read

TraceSources

Tx: Send - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
Rx: Receive - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
Drop: Drop - DropReason, packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.

Definition at line 64 of file sixlowpan-net-device.h.

Member Typedef Documentation

typedef std::pair< std::pair<Address, Address>, std::pair<uint16_t, uint16_t> > ns3::SixLowPanNetDevice::FragmentKey

private

Fragment identifier type: src/dst address src/dst port.

Definition at line 315 of file sixlowpan-net-device.h.

typedef std::map< FragmentKey, Ptr<Fragments> > ns3::SixLowPanNetDevice::MapFragments_t

private

Container for fragment key -> fragments.

Definition at line 424 of file sixlowpan-net-device.h.

typedef std::map< FragmentKey, Ptr<Fragments> >::iterator ns3::SixLowPanNetDevice::MapFragmentsI_t

private

Container Iterator for fragment key -> fragments.

Definition at line 428 of file sixlowpan-net-device.h.

typedef std::map< FragmentKey, EventId > ns3::SixLowPanNetDevice::MapFragmentsTimers_t

private

Container for fragment key -> exiration event.

Definition at line 432 of file sixlowpan-net-device.h.

typedef std::map< FragmentKey, EventId >::iterator ns3::SixLowPanNetDevice::MapFragmentsTimersI_t

private

Container Iterator for fragment key -> exiration event.

Definition at line 436 of file sixlowpan-net-device.h.

Member Enumeration Documentation

enum ns3::SixLowPanNetDevice::DropReason

Enumeration of the dropping reasons in SixLoWPAN.

Enumerator
DROP_FRAGMENT_TIMEOUT	Fragment timeout exceeded.
DROP_FRAGMENT_BUFFER_FULL	Fragment buffer size exceeded.
DROP_UNKNOWN_EXTENSION	Unsupported compression kind.

Definition at line 70 of file sixlowpan-net-device.h.

Constructor & Destructor Documentation

ns3::SixLowPanNetDevice::SixLowPanNetDevice ( )

Constructor for the SixLowPanNetDevice.

Definition at line 95 of file sixlowpan-net-device.cc.

References m_netDevice, m_rng, and NS_LOG_FUNCTION.

ns3::SixLowPanNetDevice::SixLowPanNetDevice ( SixLowPanNetDevice const & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

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

Definition at line 320 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

int64_t ns3::SixLowPanNetDevice::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

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

References m_rng, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

bool ns3::SixLowPanNetDevice::CanCompressLowPanNhc ( uint8_t headerType )

private

Checks if the next header can be compressed using NHC.

Parameters

headerType the header kind to be compressed

Returns: true if the header can be compressed

Definition at line 975 of file sixlowpan-net-device.cc.

References ns3::Ipv6Header::IPV6_EXT_FRAGMENTATION, ns3::Ipv6Header::IPV6_EXT_HOP_BY_HOP, ns3::Ipv6Header::IPV6_EXT_MOBILITY, ns3::Ipv6Header::IPV6_EXT_ROUTING, ns3::Ipv6Header::IPV6_IPV6, and ns3::Ipv6Header::IPV6_UDP.

Referenced by CompressLowPanIphc(), and CompressLowPanNhc().

Here is the caller graph for this function:

uint32_t ns3::SixLowPanNetDevice::CompressLowPanHc1	(	Ptr< Packet >	packet,
		Address const &	src,
		Address const &	dst
	)

private

Compress the headers according to HC1 compression.

Parameters

packet	the packet to be compressed
src	the MAC source address
dst	the MAC destination address

Returns: the size of the removed headers

Definition at line 525 of file sixlowpan-net-device.cc.

Referenced by Send(), and SendFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::SixLowPanNetDevice::CompressLowPanIphc	(	Ptr< Packet >	packet,
		Address const &	src,
		Address const &	dst
	)

private

Compress the headers according to IPHC compression.

Parameters

packet	the packet to be compressed
src	the MAC source address
dst	the MAC destination address

Returns: the size of the removed headers

Definition at line 748 of file sixlowpan-net-device.cc.

Referenced by CompressLowPanNhc(), Send(), and SendFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::SixLowPanNetDevice::CompressLowPanNhc	(	Ptr< Packet >	packet,
		uint8_t	headerType,
		Address const &	src,
		Address const &	dst
	)

private

Compress the headers according to NHC compression.

Parameters

packet	the packet to be compressed
headerType	the header type
src	the MAC source address
dst	the MAC destination address

Returns: the size of the removed headers

Definition at line 1121 of file sixlowpan-net-device.cc.

Referenced by CompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::SixLowPanNetDevice::CompressLowPanUdpNhc	(	Ptr< Packet >	packet,
		bool	omitChecksum
	)

private

Compress the headers according to NHC compression.

Parameters

packet	the packet to be compressed
omitChecksum	omit UDP checksum (if true)

Returns: the size of the removed headers

Definition at line 1589 of file sixlowpan-net-device.cc.

Referenced by CompressLowPanIphc(), and CompressLowPanNhc().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::DecompressLowPanHc1	(	Ptr< Packet >	packet,
		Address const &	src,
		Address const &	dst
	)

private

Decompress the headers according to HC1 compression.

Parameters

packet	the packet to be compressed
src	the MAC source address
dst	the MAC destination address

Definition at line 631 of file sixlowpan-net-device.cc.

Referenced by ProcessFragment(), and ReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::DecompressLowPanIphc	(	Ptr< Packet >	packet,
		Address const &	src,
		Address const &	dst
	)

private

Decompress the headers according to IPHC compression.

Parameters

packet	the packet to be compressed
src	the MAC source address
dst	the MAC destination address

Definition at line 996 of file sixlowpan-net-device.cc.

Referenced by DecompressLowPanNhc(), ProcessFragment(), and ReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t ns3::SixLowPanNetDevice::DecompressLowPanNhc	(	Ptr< Packet >	packet,
		Address const &	src,
		Address const &	dst,
		Ipv6Address	srcAddress,
		Ipv6Address	dstAddress
	)

private

Decompress the headers according to NHC compression.

Parameters

packet	the packet to be compressed
src	the MAC source address
dst	the MAC destination address
srcAddress	the IPv6 source address
dstAddress	the IPv6 destination address

Returns: the decompressed header type

Definition at line 1380 of file sixlowpan-net-device.cc.

Referenced by DecompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::DecompressLowPanUdpNhc	(	Ptr< Packet >	packet,
		Ipv6Address	saddr,
		Ipv6Address	daddr
	)

private

Decompress the headers according to NHC compression.

Parameters

packet	the packet to be compressed
saddr	the IPv6 source address
daddr	the IPv6 destination address

Definition at line 1644 of file sixlowpan-net-device.cc.

Referenced by DecompressLowPanIphc(), and DecompressLowPanNhc().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::DoDispose ( void )

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 135 of file sixlowpan-net-device.cc.

References ns3::Object::DoDispose(), m_fragments, m_fragmentsTimers, m_netDevice, m_node, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::SixLowPanNetDevice::DoFragmentation	(	Ptr< Packet >	packet,
		uint32_t	origPacketSize,
		uint32_t	origHdrSize,
		std::list< Ptr< Packet > > &	listFragments
	)

private

Return the instance type identifier.

Parameters

packet	the packet to be fragmented (with headers already compressed with 6LoWPAN)
origPacketSize	the size of the IP packet before the 6LoWPAN header compression, including the IP/L4 headers
origHdrSize	the size of the IP header before the 6LoWPAN header compression
listFragments	a reference to the list of the resulting packets, all with the proper headers in place

Definition at line 1713 of file sixlowpan-net-device.cc.

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Packet::CreateFragment(), ns3::SixLowPanFrag1::GetSerializedSize(), ns3::SixLowPanFragN::GetSerializedSize(), ns3::Packet::GetSize(), ns3::UniformRandomVariable::GetValue(), m_netDevice, m_rng, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::SixLowPanFragN::SetDatagramOffset(), ns3::SixLowPanFrag1::SetDatagramSize(), ns3::SixLowPanFragN::SetDatagramSize(), ns3::SixLowPanFrag1::SetDatagramTag(), and ns3::SixLowPanFragN::SetDatagramTag().

Referenced by Send(), and SendFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::DropOldestFragmentSet ( )

private

Drops the oldest fragment set.

Address ns3::SixLowPanNetDevice::GetAddress ( void ) const

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

Definition at line 282 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Address ns3::SixLowPanNetDevice::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 336 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Ptr< Channel > ns3::SixLowPanNetDevice::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.

Definition at line 266 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

uint32_t ns3::SixLowPanNetDevice::GetIfIndex ( void ) const

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 259 of file sixlowpan-net-device.cc.

References m_netDevice, and NS_LOG_FUNCTION.

Referenced by ProcessFragment(), ReceiveFromDevice(), Send(), and SendFrom().

Here is the caller graph for this function:

uint16_t ns3::SixLowPanNetDevice::GetMtu ( void ) const

virtual

Returns the link-layer MTU for this interface.

If the link-layer MTU is smaller than IPv6's minimum MTU (RFC 4944), 1280 will be returned.

Returns: the link-level MTU in bytes for this interface.

Implements ns3::NetDevice.

Definition at line 298 of file sixlowpan-net-device.cc.

References m_netDevice, and NS_LOG_FUNCTION.

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

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 352 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Address ns3::SixLowPanNetDevice::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 360 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::SixLowPanNetDevice::GetNetDevice ( ) const

Returns a smart pointer to the underlying NetDevice.

Returns: a smart pointer to the underlying NetDevice.

Definition at line 105 of file sixlowpan-net-device.cc.

References m_netDevice, and NS_LOG_FUNCTION.

Ptr< Node > ns3::SixLowPanNetDevice::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 486 of file sixlowpan-net-device.cc.

References m_node, and NS_LOG_FUNCTION.

TypeId ns3::SixLowPanNetDevice::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 52 of file sixlowpan-net-device.cc.

References m_dropTrace, m_etherType, m_forceEtherType, m_fragmentExpirationTimeout, m_fragmentReassemblyListSize, m_omitUdpChecksum, m_rxTrace, m_txTrace, m_useIphc, ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::SixLowPanNetDevice::HandleFragmentsTimeout	(	FragmentKey	key,
		uint32_t	iif
	)

private

Process the timeout for packet fragments.

Parameters

key	representing the packet fragments
iif	Input Interface

Definition at line 2046 of file sixlowpan-net-device.cc.

References DROP_FRAGMENT_TIMEOUT, ns3::Object::GetObject(), list, m_dropTrace, m_fragments, m_fragmentsTimers, m_node, and NS_LOG_FUNCTION.

Referenced by ProcessFragment().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::SixLowPanNetDevice::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 376 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

bool ns3::SixLowPanNetDevice::IsBroadcast ( void ) const

virtual

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

Implements ns3::NetDevice.

Definition at line 328 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

bool ns3::SixLowPanNetDevice::IsLinkUp ( void ) const

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 312 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

bool ns3::SixLowPanNetDevice::IsMulticast ( void ) const

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 344 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

bool ns3::SixLowPanNetDevice::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 368 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Ipv6Address ns3::SixLowPanNetDevice::MakeGlobalAddressFromMac	(	Address const &	addr,
		Ipv6Address	prefix
	)

private

make a global address from a MAC address.

Parameters

addr	the MAC address
prefix	the address prefix

Returns: the IPv6 address

Definition at line 2090 of file sixlowpan-net-device.cc.

References ns3::Mac16Address::ConvertFrom(), ns3::Mac64Address::ConvertFrom(), ns3::Mac48Address::ConvertFrom(), ns3::Ipv6Address::GetAny(), ns3::Ipv6Address::IsAny(), ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), ns3::Mac48Address::IsMatchingType(), m_forceEtherType, ns3::Ipv6Address::MakeAutoconfiguredAddress(), and NS_ABORT_MSG.

Referenced by DecompressLowPanHc1().

Here is the call graph for this function:

Here is the caller graph for this function:

Ipv6Address ns3::SixLowPanNetDevice::MakeLinkLocalAddressFromMac ( Address const & addr )

private

make a link-local address from a MAC address.

Parameters

addr	the MAC address

Returns: the IPv6 link-local address

Definition at line 2064 of file sixlowpan-net-device.cc.

References ns3::Mac16Address::ConvertFrom(), ns3::Mac64Address::ConvertFrom(), ns3::Mac48Address::ConvertFrom(), ns3::Ipv6Address::GetAny(), ns3::Ipv6Address::IsAny(), ns3::Mac16Address::IsMatchingType(), ns3::Mac64Address::IsMatchingType(), ns3::Mac48Address::IsMatchingType(), m_forceEtherType, ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), and NS_ABORT_MSG.

Referenced by CompressLowPanHc1(), CompressLowPanIphc(), DecompressLowPanHc1(), and DecompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::SixLowPanNetDevice::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 498 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

SixLowPanNetDevice& ns3::SixLowPanNetDevice::operator= ( SixLowPanNetDevice const & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

bool ns3::SixLowPanNetDevice::ProcessFragment	(	Ptr< Packet > &	packet,
		Address const &	src,
		Address const &	dst,
		bool	isFirst
	)

private

Process a packet fragment.

Parameters

packet	the packet
src	the source MAC address
dst	the destination MAC address
isFirst	true if it is the first fragment, false otherwise

Returns: true is the fragment completed the packet

Definition at line 1785 of file sixlowpan-net-device.cc.

References ns3::SixLowPanNetDevice::Fragments::AddFirstFragment(), ns3::SixLowPanNetDevice::Fragments::AddFragment(), ns3::Packet::Copy(), DecompressLowPanHc1(), DecompressLowPanIphc(), DROP_FRAGMENT_BUFFER_FULL, ns3::SixLowPanFragN::GetDatagramOffset(), ns3::SixLowPanFrag1::GetDatagramSize(), ns3::SixLowPanFragN::GetDatagramSize(), ns3::SixLowPanFrag1::GetDatagramTag(), ns3::SixLowPanFragN::GetDatagramTag(), ns3::SixLowPanDispatch::GetDispatchType(), GetIfIndex(), ns3::Object::GetObject(), ns3::SixLowPanNetDevice::Fragments::GetPacket(), ns3::Packet::GetSize(), HandleFragmentsTimeout(), ns3::SixLowPanNetDevice::Fragments::IsEntire(), list, ns3::SixLowPanDispatch::LOWPAN_HC1, ns3::SixLowPanDispatch::LOWPAN_IPHC, ns3::SixLowPanDispatch::LOWPAN_NOTCOMPRESSED, m_dropTrace, m_fragmentExpirationTimeout, m_fragmentReassemblyListSize, m_fragments, m_fragmentsTimers, m_node, ns3::Simulator::Now(), NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::RemoveHeader(), ns3::Simulator::Schedule(), and ns3::SixLowPanNetDevice::Fragments::SetPacketSize().

Referenced by ReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::ReceiveFromDevice	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		Address const &	source,
		Address const &	destination,
		PacketType	packetType
	)

private

receives all the packets from a NetDevice for further processing.

Parameters

device	the NetDevice the packet ws received from
packet	the received packet
protocol	the protocol (if known)
source	the source address
destination	the destination address
packetType	the packet kind (e.g., HOST, BROADCAST, etc.)

Returns: the IPv6 link-local address

Definition at line 157 of file sixlowpan-net-device.cc.

Referenced by SetNetDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::SixLowPanNetDevice::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 384 of file sixlowpan-net-device.cc.

References CompressLowPanHc1(), CompressLowPanIphc(), DoFragmentation(), ns3::Node::GetId(), GetIfIndex(), ns3::Object::GetObject(), ns3::Packet::GetSize(), m_etherType, m_forceEtherType, m_netDevice, m_node, m_txTrace, m_useIphc, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

bool ns3::SixLowPanNetDevice::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 435 of file sixlowpan-net-device.cc.

References CompressLowPanHc1(), CompressLowPanIphc(), DoFragmentation(), GetIfIndex(), ns3::Object::GetObject(), ns3::Packet::GetSize(), m_etherType, m_forceEtherType, m_netDevice, m_node, m_txTrace, m_useIphc, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::SixLowPanNetDevice::SetAddress ( Address address )

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

Definition at line 274 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

void ns3::SixLowPanNetDevice::SetIfIndex ( const uint32_t index )

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 252 of file sixlowpan-net-device.cc.

References m_ifIndex, and NS_LOG_FUNCTION.

bool ns3::SixLowPanNetDevice::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 290 of file sixlowpan-net-device.cc.

References m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

void ns3::SixLowPanNetDevice::SetNetDevice ( Ptr< NetDevice > device )

Setup SixLowPan to be a proxy for the specified NetDevice.

All the packets incoming and outgoing from the NetDevice will be processed by SixLowPanNetDevice.

Parameters

device a smart pointer to the NetDevice to be proxied.

Definition at line 111 of file sixlowpan-net-device.cc.

References m_etherType, m_forceEtherType, m_netDevice, m_node, ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ReceiveFromDevice(), and ns3::Node::RegisterProtocolHandler().

Referenced by SixlowpanHc1ImplTest::DoRun(), SixlowpanIphcImplTest::DoRun(), and SixlowpanFragmentationTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::SixLowPanNetDevice::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 492 of file sixlowpan-net-device.cc.

References m_node, and NS_LOG_FUNCTION.

void ns3::SixLowPanNetDevice::SetPromiscReceiveCallback ( NetDevice::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 512 of file sixlowpan-net-device.cc.

References m_promiscRxCallback, and NS_LOG_FUNCTION.

void ns3::SixLowPanNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback cb )

virtual

Parameters