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

#include "sixlowpan-net-device.h"

Inheritance diagram for ns3::SixLowPanNetDevice:

Collaboration diagram for ns3::SixLowPanNetDevice:

Classes
struct	ContextEntry
	Structure holding the informations for a context (used in compression and decompression) More...

class	Fragments
	A Set of Fragments. More...

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

typedef void(*	DropTracedCallback) (DropReason reason, Ptr< const Packet > packet, Ptr< SixLowPanNetDevice > sixNetDevice, uint32_t ifindex)
	TracedCallback signature fo packet drop events. More...

typedef void(*	RxTxTracedCallback) (Ptr< const Packet > packet, Ptr< SixLowPanNetDevice > sixNetDevice, uint32_t ifindex)
	TracedCallback signature for packet send/receive events. More...

Public Types inherited from ns3::NetDevice
typedef void(*	LinkChangeTracedCallback) (void)
	TracedCallback signature for link changed event. More...

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

	SixLowPanNetDevice (SixLowPanNetDevice const &)=delete

void	AddContext (uint8_t contextId, Ipv6Prefix contextPrefix, bool compressionAllowed, Time validLifetime)
	Add, remove, or update a context used in IPHC stateful compression. 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

bool	GetContext (uint8_t contextId, Ipv6Prefix &contextPrefix, bool &compressionAllowed, Time &validLifetime)
	Get a context used in IPHC stateful compression. More...

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

void	InvalidateContext (uint8_t contextId)
	Invalidate a context used in IPHC stateful compression. More...

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

SixLowPanNetDevice &	operator= (SixLowPanNetDevice const &)=delete

void	RemoveContext (uint8_t contextId)
	Remove a context used in IPHC stateful compression. More...

void	RenewContext (uint8_t contextId, Time validLifetime)
	Renew a context used in IPHC stateful compression. More...

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

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. 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)
	Destructor implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

typedef std::list< std::tuple< Time, FragmentKey_t, uint32_t > >	FragmentsTimeoutsList_t
	Container for fragment timeouts. More...

typedef std::list< std::tuple< Time, FragmentKey_t, uint32_t > >::iterator	FragmentsTimeoutsListI_t
	Container Iterator for fragment timeouts. More...

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

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

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

Ipv6Address	CleanPrefix (Ipv6Address address, Ipv6Prefix prefix)
	Clean an address from its prefix. 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...

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

std::pair< uint8_t, bool >	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, uint32_t extraHdrSize, std::list< Ptr< Packet > > &listFragments)
	Performs a packet fragmentation. More...

bool	DoSend (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber, bool doSendFrom)

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

bool	FindMulticastCompressionContext (Ipv6Address address, uint8_t &contextId)
	Finds if the given multicast address matches a context for compression. More...

bool	FindUnicastCompressionContext (Ipv6Address address, uint8_t &contextId)
	Finds if the given unicast address matches a context for compression. More...

Address	Get16MacFrom48Mac (Address addr)
	Get a Mac16 from its Mac48 pseudo-MAC. More...

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

void	HandleTimeout (void)
	Handles a fragmented packet timeout. 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...

FragmentsTimeoutsListI_t	SetTimeout (FragmentKey_t key, uint32_t iif)
	Set a new timeout "event" for a fragmented packet. More...

Private Attributes
uint8_t	m_bc0Serial
	Serial number used in BC0 header. More...

uint32_t	m_compressionThreshold
	Minimum L2 payload size. More...

std::map< uint8_t, ContextEntry >	m_contextTable
	Table of the contexts used in compression/decompression. More...

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

uint32_t	m_ifIndex
	Interface index. More...

uint16_t	m_meshCacheLength
	length of the cache for each source. More...

bool	m_meshUnder
	Use a mesh-under routing. More...

uint8_t	m_meshUnderHopsLeft
	Start value for mesh-under hops left. More...

Ptr< RandomVariableStream >	m_meshUnderJitter
	Random variable for the mesh-under packet retransmission. 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...

std::map< Address, std::list< uint8_t > >	m_seenPkts
	Seen packets, memorized by OriginatorAdddress, SequenceNumber. More...

EventId	m_timeoutEvent
	Event for the next scheduled timeout. More...

FragmentsTimeoutsList_t	m_timeoutEventList
	Timeout "events" container. 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...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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 +9.22337e+18ns:+9.22337e+18ns
- Initial value: +6e+10ns
- Flags: construct write read
CompressionThreshold: The minimum MAC layer payload size.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- 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
UseMeshUnder: Use a mesh-under routing protocol.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
MeshUnderRadius: Hops Left to use in mesh-under.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 10
- Flags: construct write read
MeshCacheLength: Length of the cache for each source.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 10
- Flags: construct write read
MeshUnderJitter: The jitter in ms a node uses to forward mesh-under packets - used to prevent collisions
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=10.0]
- Flags: construct write read

TraceSources

Tx: Send - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
Callback signature: ns3::SixLowPanNetDevice::RxTxTracedCallback
Rx: Receive - packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
Callback signature: ns3::SixLowPanNetDevice::RxTxTracedCallback
Drop: Drop - DropReason, packet (including 6LoWPAN header), SixLoWPanNetDevice Ptr, interface index.
Callback signature: ns3::SixLowPanNetDevice::DropTracedCallback

Size of this type is 376 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ DropTracedCallback

typedef void(* ns3::SixLowPanNetDevice::DropTracedCallback) (DropReason reason, Ptr< const Packet > packet, Ptr< SixLowPanNetDevice > sixNetDevice, uint32_t ifindex)

TracedCallback signature fo packet drop events.

Parameters

[in]	reason	The reason for the drop.
[in]	packet	The packet.
[in]	sixNetDevice	The SixLowPanNetDevice.
[in]	ifindex	The ifindex of the device.

Deprecated:: The non-const Ptr<SixLowPanNetDevice> argument is deprecated and will be changed to Ptr<const SixLowPanNetDevice> in a future release.

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

◆ FragmentKey_t

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

private

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

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

◆ FragmentsTimeoutsList_t

typedef std::list< std::tuple <Time, FragmentKey_t, uint32_t > > ns3::SixLowPanNetDevice::FragmentsTimeoutsList_t

private

Container for fragment timeouts.

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

◆ FragmentsTimeoutsListI_t

typedef std::list< std::tuple <Time, FragmentKey_t, uint32_t > >::iterator ns3::SixLowPanNetDevice::FragmentsTimeoutsListI_t

private

Container Iterator for fragment timeouts.

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

◆ MapFragments_t

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

private

Container for fragment key -> fragments.

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

◆ MapFragmentsI_t

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

private

Container Iterator for fragment key -> fragments.

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

◆ RxTxTracedCallback

typedef void(* ns3::SixLowPanNetDevice::RxTxTracedCallback) (Ptr< const Packet > packet, Ptr< SixLowPanNetDevice > sixNetDevice, uint32_t ifindex)

TracedCallback signature for packet send/receive events.

Parameters

[in]	packet	The packet.
[in]	sixNetDevice	The SixLowPanNetDevice.
[in]	ifindex	The ifindex of the device.

Deprecated:: The non-const Ptr<SixLowPanNetDevice> argument is deprecated and will be changed to Ptr<const SixLowPanNetDevice> in a future release.

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

Member Enumeration Documentation

◆ DropReason

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.
DROP_DISALLOWED_COMPRESSION	HC1 while in IPHC mode or viceversa.
DROP_SATETFUL_DECOMPRESSION_PROBLEM	Decompression failed due to missing or expired context.

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

Constructor & Destructor Documentation

◆ SixLowPanNetDevice() [1/2]

ns3::SixLowPanNetDevice::SixLowPanNetDevice ( )

Constructor for the SixLowPanNetDevice.

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

References m_bc0Serial, m_netDevice, m_rng, and NS_LOG_FUNCTION.

◆ SixLowPanNetDevice() [2/2]

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

delete

Member Function Documentation

◆ AddContext()

void ns3::SixLowPanNetDevice::AddContext	(	uint8_t	contextId,
		Ipv6Prefix	contextPrefix,
		bool	compressionAllowed,
		Time	validLifetime
	)

Add, remove, or update a context used in IPHC stateful compression.

A context with a zero validLifetime will be immediately removed.

Parameters

[in]	contextId	context id (most be between 0 and 15 included).
[in]	contextPrefix	context prefix to be used in compression/decompression.
[in]	compressionAllowed	compression and decompression allowed (true), decompression only (false).
[in]	validLifetime	validity time (relative to the actual time).

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

References ns3::Time::As(), ns3::Ipv6Address::GetOnes(), m_contextTable, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Time::S.

Here is the call graph for this function:

◆ AddLinkChangeCallback()

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

References ns3::NetDevice::AddLinkChangeCallback(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ AssignStreams()

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

[in] stream First stream index to use.

Returns: the number of stream indices assigned by this model.

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

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

Here is the call graph for this function:

◆ CanCompressLowPanNhc()

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

private

Checks if the next header can be compressed using NHC.

Parameters

[in] headerType The header kind to be compressed.

Returns: True if the header can be compressed.

Definition at line 1309 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:

◆ CleanPrefix()

Ipv6Address ns3::SixLowPanNetDevice::CleanPrefix	(	Ipv6Address	address,
		Ipv6Prefix	prefix
	)

private

Clean an address from its prefix.

This function is used to find the relevant bits to be sent in stateful IPHC compression. Only the pefix length is used - the address prefix is assumed to be matching the prefix.

Parameters

address	the address to be cleaned
prefix	the prefix to remove

Returns: An address with the prefix zeroed.

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

References first::address, ns3::Ipv6Address::Deserialize(), and ns3::Ipv6Prefix::GetPrefixLength().

Referenced by CompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CompressLowPanHc1()

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

private

Compress the headers according to HC1 compression.

Parameters

[in]	packet	The packet to be compressed.
[in]	src	The MAC source address.
[in]	dst	The MAC destination address.

Returns: The size of the removed headers.

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

Referenced by DoSend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CompressLowPanIphc()

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

private

Compress the headers according to IPHC compression.

Parameters

[in]	packet	The packet to be compressed.
[in]	src	The MAC source address.
[in]	dst	The MAC destination address.

Returns: The size of the removed headers.

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

Referenced by CompressLowPanNhc(), and DoSend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CompressLowPanNhc()

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

[in]	packet	The packet to be compressed.
[in]	headerType	The header type.
[in]	src	The MAC source address.
[in]	dst	The MAC destination address.

Returns: The size of the removed headers.

Definition at line 1652 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:

◆ CompressLowPanUdpNhc()

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

private

Compress the headers according to NHC compression.

Parameters

[in]	packet	The packet to be compressed.
[in]	omitChecksum	Omit UDP checksum (if true).

Returns: The size of the removed headers.

Definition at line 2127 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:

◆ DecompressLowPanHc1()

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

private

Decompress the headers according to HC1 compression.

Parameters

[in]	packet	the packet to be compressed.
[in]	src	the MAC source address.
[in]	dst	the MAC destination address.

Definition at line 823 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:

◆ DecompressLowPanIphc()

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

private

Decompress the headers according to IPHC compression.

Parameters

[in]	packet	The packet to be compressed.
[in]	src	The MAC source address.
[in]	dst	The MAC destination address.

Returns: true if the packet can not be decompressed due to wrong context informations.

Definition at line 1330 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:

◆ DecompressLowPanNhc()

std::pair< uint8_t, bool > 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

[in]	packet	The packet to be compressed.
[in]	src	The MAC source address.
[in]	dst	The MAC destination address.
[in]	srcAddress	The IPv6 source address.
[in]	dstAddress	The IPv6 destination address.

Returns: A std::pair containing the decompressed header type and a flag - true if the packet can not be decompressed due to wrong context informations.

Definition at line 1911 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:

◆ DecompressLowPanUdpNhc()

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

private

Decompress the headers according to NHC compression.

Parameters

[in]	packet	The packet to be compressed.
[in]	saddr	The IPv6 source address.
[in]	daddr	The IPv6 destination address.

Definition at line 2182 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:

◆ DoDispose()

void ns3::SixLowPanNetDevice::DoDispose ( void )

protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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 169 of file sixlowpan-net-device.cc.

References ns3::EventId::Cancel(), ns3::Object::DoDispose(), ns3::EventId::IsRunning(), m_fragments, m_netDevice, m_node, m_timeoutEvent, m_timeoutEventList, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoFragmentation()

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

private

Performs a packet fragmentation.

Parameters

[in]	packet	the packet to be fragmented (with headers already compressed with 6LoWPAN).
[in]	origPacketSize	the size of the IP packet before the 6LoWPAN header compression, including the IP/L4 headers.
[in]	origHdrSize	the size of the IP header before the 6LoWPAN header compression.
[in]	extraHdrSize	the sum of the sizes of BC0 header and MESH header if mesh routing is used or 0.
[out]	listFragments	A reference to the list of the resulting packets, all with the proper headers in place.

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

References ns3::Packet::AddHeader(), ns3::Packet::Copy(), ns3::Packet::CreateFragment(), ns3::NetDevice::GetMtu(), 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, packetSize, ns3::SixLowPanFragN::SetDatagramOffset(), ns3::SixLowPanFrag1::SetDatagramSize(), ns3::SixLowPanFragN::SetDatagramSize(), ns3::SixLowPanFrag1::SetDatagramTag(), and ns3::SixLowPanFragN::SetDatagramTag().

Referenced by DoSend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSend()

bool ns3::SixLowPanNetDevice::DoSend	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber,
		bool	doSendFrom
	)

private

Parameters

[in]	packet	Packet sent from above down to Network Device.
[in]	source	Source mac address (only used if doSendFrom is true, i.e., "MAC spoofing").
[in]	dest	Mac address of the destination (already resolved).
[in]	protocolNumber	Identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.
[in]	doSendFrom	Perform a SendFrom instead of a Send.

Called from higher layer to send packet into Network Device with the specified source and destination Addresses.

Returns: Whether the Send operation succeeded.

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

References ns3::Packet::AddHeader(), CompressLowPanHc1(), CompressLowPanIphc(), ns3::Packet::Copy(), DoFragmentation(), Get16MacFrom48Mac(), ns3::NetDevice::GetAddress(), ns3::NetDevice::GetBroadcast(), ns3::Node::GetId(), GetIfIndex(), ns3::NetDevice::GetMtu(), ns3::SixLowPanBc0::GetSerializedSize(), ns3::SixLowPanMesh::GetSerializedSize(), ns3::Packet::GetSize(), ns3::Mac48Address::IsMatchingType(), m_bc0Serial, m_compressionThreshold, m_etherType, m_forceEtherType, m_meshUnder, m_meshUnderHopsLeft, m_netDevice, m_node, m_txTrace, m_useIphc, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, pktSize, ns3::NetDevice::Send(), ns3::NetDevice::SendFrom(), ns3::SixLowPanMesh::SetFinalDst(), ns3::SixLowPanMesh::SetHopsLeft(), ns3::SixLowPanMesh::SetOriginator(), and ns3::SixLowPanBc0::SetSequenceNumber().

Referenced by Send(), and SendFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DropOldestFragmentSet()

void ns3::SixLowPanNetDevice::DropOldestFragmentSet ( )

private

Drops the oldest fragment set.

◆ FindMulticastCompressionContext()

bool ns3::SixLowPanNetDevice::FindMulticastCompressionContext	(	Ipv6Address	address,
		uint8_t &	contextId
	)

private

Finds if the given multicast address matches a context for compression.

Parameters

[in]	address	the address to check
[out]	contextId	the context found

Returns: true if a valid context has been found

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

References first::address, ns3::SixLowPanNetDevice::ContextEntry::compressionAllowed, ns3::SixLowPanNetDevice::ContextEntry::contextPrefix, ns3::Ipv6Prefix::GetBytes(), ns3::Ipv6Address::GetOnes(), ns3::Ipv6Prefix::GetPrefixLength(), m_contextTable, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SixLowPanNetDevice::ContextEntry::validLifetime.

Referenced by CompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindUnicastCompressionContext()

bool ns3::SixLowPanNetDevice::FindUnicastCompressionContext	(	Ipv6Address	address,
		uint8_t &	contextId
	)

private

Finds if the given unicast address matches a context for compression.

Parameters

[in]	address	the address to check
[out]	contextId	the context found

Returns: true if a valid context has been found

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

References first::address, ns3::SixLowPanNetDevice::ContextEntry::compressionAllowed, ns3::SixLowPanNetDevice::ContextEntry::contextPrefix, ns3::Ipv6Address::GetOnes(), m_contextTable, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SixLowPanNetDevice::ContextEntry::validLifetime.

Referenced by CompressLowPanIphc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get16MacFrom48Mac()

Address ns3::SixLowPanNetDevice::Get16MacFrom48Mac ( Address addr )

private

Get a Mac16 from its Mac48 pseudo-MAC.

Parameters

addr	the PseudoMac address

Returns: the Mac16Address

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

References ns3::Mac16Address::CopyFrom(), ns3::Address::CopyTo(), ns3::Mac48Address::IsMatchingType(), and NS_ASSERT_MSG.

Referenced by DoSend(), and ReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddress()

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

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

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

References ns3::NetDevice::GetAddress(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetBroadcast()

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

References ns3::NetDevice::GetBroadcast(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetChannel()

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

References ns3::NetDevice::GetChannel(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetContext()

bool ns3::SixLowPanNetDevice::GetContext	(	uint8_t	contextId,
		Ipv6Prefix &	contextPrefix,
		bool &	compressionAllowed,
		Time &	validLifetime
	)

Get a context used in IPHC stateful compression.

Parameters

[in]	contextId	context id (most be between 0 and 15 included).
[out]	contextPrefix	context prefix to be used in compression/decompression.
[out]	compressionAllowed	compression and decompression allowed (true), decompression only (false).
[out]	validLifetime	validity time (relative to the actual time).

Returns: false if the context has not been found.

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

References m_contextTable, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ GetIfIndex()

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

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex, and NS_LOG_FUNCTION.

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

Here is the caller graph for this function:

◆ GetMtu()

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

References ns3::NetDevice::GetMtu(), m_netDevice, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMulticast() [1/2]

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: IsMulticast()

Implements ns3::NetDevice.

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

References ns3::NetDevice::GetMulticast(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMulticast() [2/2]

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

References ns3::NetDevice::GetMulticast(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetNetDevice()

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

References m_netDevice, and NS_LOG_FUNCTION.

◆ GetNode()

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

References m_node, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::SixLowPanNetDevice::GetTypeId ( void )

static

Get the type ID.

Returns: The object TypeId.

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

References m_compressionThreshold, m_dropTrace, m_etherType, m_forceEtherType, m_fragmentExpirationTimeout, m_fragmentReassemblyListSize, m_meshCacheLength, m_meshUnder, m_meshUnderHopsLeft, m_meshUnderJitter, m_omitUdpChecksum, m_rxTrace, m_txTrace, m_useIphc, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleFragmentsTimeout()

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

private

Process the timeout for packet fragments.

Parameters

[in]	key	A key representing the packet fragments.
[in]	iif	Input Interface.

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

References DROP_FRAGMENT_TIMEOUT, list, m_dropTrace, m_fragments, and NS_LOG_FUNCTION.

Referenced by HandleTimeout().

Here is the caller graph for this function:

◆ HandleTimeout()

void ns3::SixLowPanNetDevice::HandleTimeout ( void )

private

Handles a fragmented packet timeout.

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

References HandleFragmentsTimeout(), m_timeoutEvent, m_timeoutEventList, ns3::Simulator::Now(), and ns3::Simulator::Schedule().

Referenced by SetTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InvalidateContext()

void ns3::SixLowPanNetDevice::InvalidateContext ( uint8_t contextId )

Invalidate a context used in IPHC stateful compression.

An invalid context will not be used for compression but it will be used for decompression.

Parameters

[in] contextId context id (most be between 0 and 15 included).

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

References m_contextTable, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ IsBridge()

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

References ns3::NetDevice::IsBridge(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ IsBroadcast()

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

virtual

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

Implements ns3::NetDevice.

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

References ns3::NetDevice::IsBroadcast(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ IsLinkUp()

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

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

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

References ns3::NetDevice::IsLinkUp(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ IsMulticast()

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

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

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

References ns3::NetDevice::IsMulticast(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ IsPointToPoint()

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

References ns3::NetDevice::IsPointToPoint(), m_netDevice, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NeedsArp()

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

References m_netDevice, ns3::NetDevice::NeedsArp(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ operator=()

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

delete

◆ ProcessFragment()

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

private

Process a packet fragment.

Parameters

[in]	packet	The packet.
[in]	src	The source MAC address.
[in]	dst	The destination MAC address.
[in]	isFirst	True if it is the first fragment, false otherwise.

Returns: True is the fragment completed the packet.

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

References ns3::SixLowPanNetDevice::Fragments::AddFirstFragment(), ns3::SixLowPanNetDevice::Fragments::AddFragment(), ns3::Packet::Copy(), ns3::Packet::CopyData(), DecompressLowPanHc1(), DecompressLowPanIphc(), DROP_FRAGMENT_BUFFER_FULL, DROP_SATETFUL_DECOMPRESSION_PROBLEM, ns3::SixLowPanFragN::GetDatagramOffset(), ns3::SixLowPanFrag1::GetDatagramSize(), ns3::SixLowPanFragN::GetDatagramSize(), ns3::SixLowPanFrag1::GetDatagramTag(), ns3::SixLowPanFragN::GetDatagramTag(), ns3::SixLowPanDispatch::GetDispatchType(), GetIfIndex(), ns3::SixLowPanNetDevice::Fragments::GetPacket(), ns3::Packet::GetSize(), ns3::SixLowPanNetDevice::Fragments::GetTimeoutIter(), ns3::SixLowPanNetDevice::Fragments::IsEntire(), list, ns3::SixLowPanDispatch::LOWPAN_HC1, ns3::SixLowPanDispatch::LOWPAN_IPHC, ns3::SixLowPanDispatch::LOWPAN_IPv6, m_dropTrace, m_fragmentReassemblyListSize, m_fragments, m_timeoutEventList, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, packetSize, ns3::Packet::RemoveHeader(), ns3::SixLowPanNetDevice::Fragments::SetPacketSize(), SetTimeout(), and ns3::SixLowPanNetDevice::Fragments::SetTimeoutIter().

Referenced by ReceiveFromDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReceiveFromDevice()

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

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

Definition at line 191 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:

◆ RemoveContext()

void ns3::SixLowPanNetDevice::RemoveContext ( uint8_t contextId )

Remove a context used in IPHC stateful compression.

Parameters

[in] contextId context id (most be between 0 and 15 included).

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

References m_contextTable, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ RenewContext()

void ns3::SixLowPanNetDevice::RenewContext	(	uint8_t	contextId,
		Time	validLifetime
	)

Renew a context used in IPHC stateful compression.

The context will have its lifetime extended and its validity for compression re-enabled.

Parameters

[in]	contextId	context id (most be between 0 and 15 included).
[in]	validLifetime	validity time (relative to the actual time).

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

References ns3::Time::As(), m_contextTable, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Time::S.

Here is the call graph for this function:

◆ Send()

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

References DoSend(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SendFrom()

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

References DoSend(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetAddress()

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

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

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

References first::address, m_netDevice, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::NetDevice::SetAddress().

Here is the call graph for this function:

◆ SetIfIndex()

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

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex, and NS_LOG_FUNCTION.

◆ SetMtu()

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

References m_netDevice, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::NetDevice::SetMtu().

Here is the call graph for this function:

◆ SetNetDevice()

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

[in] device A smart pointer to the NetDevice to be proxied.

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

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

Here is the call graph for this function:

◆ SetNode()

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

References m_node, and NS_LOG_FUNCTION.

◆ SetPromiscReceiveCallback()

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

References m_promiscRxCallback, and NS_LOG_FUNCTION.

◆ SetReceiveCallback()

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

virtual

Parameters

cb	callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Set the callback to be used to notify higher layers when a packet has been received.

Implements ns3::NetDevice.

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

References m_rxCallback, and NS_LOG_FUNCTION.

◆ SetTimeout()

SixLowPanNetDevice::FragmentsTimeoutsListI_t ns3::SixLowPanNetDevice::SetTimeout	(	FragmentKey_t	key,
		uint32_t	iif
	)

private

Set a new timeout "event" for a fragmented packet.

Parameters

key	the fragment identification
iif	input interface of the packet

Returns: an iterator to the inserted "event"

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

References HandleTimeout(), m_fragmentExpirationTimeout, m_timeoutEvent, m_timeoutEventList, ns3::Simulator::Now(), and ns3::Simulator::Schedule().

Referenced by ProcessFragment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SupportsSendFrom()

bool ns3::SixLowPanNetDevice::SupportsSendFrom ( ) const

virtual

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

Implements ns3::NetDevice.

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

References NS_LOG_FUNCTION.

Member Data Documentation

◆ m_bc0Serial

uint8_t ns3::SixLowPanNetDevice::m_bc0Serial

private

Serial number used in BC0 header.

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

Referenced by SixLowPanNetDevice(), and DoSend().

◆ m_compressionThreshold

uint32_t ns3::SixLowPanNetDevice::m_compressionThreshold

private

Minimum L2 payload size.

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

Referenced by DoSend(), and GetTypeId().

◆ m_contextTable

std::map<uint8_t, ContextEntry> ns3::SixLowPanNetDevice::m_contextTable

private

Table of the contexts used in compression/decompression.

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

Referenced by AddContext(), CompressLowPanIphc(), DecompressLowPanIphc(), FindMulticastCompressionContext(), FindUnicastCompressionContext(), GetContext(), InvalidateContext(), RemoveContext(), and RenewContext().

◆ m_dropTrace

TracedCallback<DropReason, Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> ns3::SixLowPanNetDevice::m_dropTrace

private

Callback to trace drop packets.

Data passed:

DropReason
Packet dropped (including 6LoWPAN header)
Ptr to SixLowPanNetDevice
interface index
Deprecated:
The non-const Ptr<SixLowPanNetDevice> argument is deprecated and will be changed to Ptr<const SixLowPanNetDevice> in a future release.

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

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

◆ m_etherType

uint16_t ns3::SixLowPanNetDevice::m_etherType

private

EtherType number (used only if m_forceEtherType is true).

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

Referenced by DoSend(), GetTypeId(), and SetNetDevice().

◆ m_forceEtherType

bool ns3::SixLowPanNetDevice::m_forceEtherType

private

Force the EtherType number.

Also implying that the underlying NetDevice is using 48-bit Addresses, e.g., Ethernet, Wi-Fi, etc.

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

Referenced by DoSend(), GetTypeId(), and SetNetDevice().

◆ m_fragmentExpirationTimeout

Time ns3::SixLowPanNetDevice::m_fragmentExpirationTimeout

private

Time limit for fragment rebuilding.

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

Referenced by GetTypeId(), and SetTimeout().

◆ m_fragmentReassemblyListSize

uint16_t ns3::SixLowPanNetDevice::m_fragmentReassemblyListSize

private

How many packets can be rebuilt at the same time.

Some real implementation do limit this. Zero means no limit.

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

Referenced by GetTypeId(), and ProcessFragment().

◆ m_fragments

MapFragments_t ns3::SixLowPanNetDevice::m_fragments

private

Fragments hold to be rebuilt.

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

Referenced by ns3::SixLowPanNetDevice::Fragments::AddFragment(), DoDispose(), ns3::SixLowPanNetDevice::Fragments::GetFraments(), ns3::SixLowPanNetDevice::Fragments::GetPacket(), HandleFragmentsTimeout(), ns3::SixLowPanNetDevice::Fragments::IsEntire(), and ProcessFragment().

◆ m_ifIndex

uint32_t ns3::SixLowPanNetDevice::m_ifIndex

private

Interface index.

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

Referenced by GetIfIndex(), and SetIfIndex().

◆ m_meshCacheLength

uint16_t ns3::SixLowPanNetDevice::m_meshCacheLength

private

length of the cache for each source.

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

Referenced by GetTypeId(), and ReceiveFromDevice().

◆ m_meshUnder

bool ns3::SixLowPanNetDevice::m_meshUnder

private

Use a mesh-under routing.

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

Referenced by DoSend(), and GetTypeId().

◆ m_meshUnderHopsLeft

uint8_t ns3::SixLowPanNetDevice::m_meshUnderHopsLeft

private

Start value for mesh-under hops left.

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

Referenced by DoSend(), and GetTypeId().

◆ m_meshUnderJitter

Ptr<RandomVariableStream> ns3::SixLowPanNetDevice::m_meshUnderJitter

private

Random variable for the mesh-under packet retransmission.

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

Referenced by AssignStreams(), GetTypeId(), and ReceiveFromDevice().

◆ m_netDevice

Ptr<NetDevice> ns3::SixLowPanNetDevice::m_netDevice

private

Smart pointer to the underlying NetDevice.

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

Referenced by SixLowPanNetDevice(), AddLinkChangeCallback(), DoDispose(), DoFragmentation(), DoSend(), GetAddress(), GetBroadcast(), GetChannel(), GetMtu(), GetMulticast(), GetNetDevice(), IsBridge(), IsBroadcast(), IsLinkUp(), IsMulticast(), IsPointToPoint(), NeedsArp(), ReceiveFromDevice(), SetAddress(), SetMtu(), and SetNetDevice().

◆ m_node

Ptr<Node> ns3::SixLowPanNetDevice::m_node

private

Smart pointer to the Node.

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

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

◆ m_omitUdpChecksum

bool ns3::SixLowPanNetDevice::m_omitUdpChecksum

private

Omit UDP checksum in NC1 encoding.

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

Referenced by CompressLowPanIphc(), CompressLowPanNhc(), and GetTypeId().

◆ m_promiscRxCallback

NetDevice::PromiscReceiveCallback ns3::SixLowPanNetDevice::m_promiscRxCallback

private

The callback used to notify higher layers that a packet has been received in promiscuous mode.

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

Referenced by ReceiveFromDevice(), and SetPromiscReceiveCallback().

◆ m_rng

Ptr<UniformRandomVariable> ns3::SixLowPanNetDevice::m_rng

private

Rng for the fragments tag.

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

Referenced by SixLowPanNetDevice(), AssignStreams(), and DoFragmentation().

◆ m_rxCallback

NetDevice::ReceiveCallback ns3::SixLowPanNetDevice::m_rxCallback

private

The callback used to notify higher layers that a packet has been received.

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

Referenced by ReceiveFromDevice(), and SetReceiveCallback().

◆ m_rxTrace

TracedCallback<Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> ns3::SixLowPanNetDevice::m_rxTrace

private

Callback to trace RX (reception) packets.

Data passed:

Packet received (including 6LoWPAN header)
Ptr to SixLowPanNetDevice
interface index
Deprecated:
The non-const Ptr<SixLowPanNetDevice> argument is deprecated and will be changed to Ptr<const SixLowPanNetDevice> in a future release.

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

Referenced by GetTypeId(), and ReceiveFromDevice().

◆ m_seenPkts

std::map<Address , std::list <uint8_t > > ns3::SixLowPanNetDevice::m_seenPkts

private

Seen packets, memorized by OriginatorAdddress, SequenceNumber.

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

Referenced by ReceiveFromDevice().

◆ m_timeoutEvent

EventId ns3::SixLowPanNetDevice::m_timeoutEvent

private

Event for the next scheduled timeout.

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

Referenced by DoDispose(), HandleTimeout(), and SetTimeout().

◆ m_timeoutEventList

FragmentsTimeoutsList_t ns3::SixLowPanNetDevice::m_timeoutEventList

private

Timeout "events" container.

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

Referenced by DoDispose(), HandleTimeout(), ProcessFragment(), and SetTimeout().

◆ m_txTrace

TracedCallback<Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> ns3::SixLowPanNetDevice::m_txTrace

private

Callback to trace TX (transmission) packets.

Data passed:

Packet received (including 6LoWPAN header)
Ptr to SixLowPanNetDevice
interface index
Deprecated:
The non-const Ptr<SixLowPanNetDevice> argument is deprecated and will be changed to Ptr<const SixLowPanNetDevice> in a future release.

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

Referenced by DoSend(), and GetTypeId().

◆ m_useIphc

bool ns3::SixLowPanNetDevice::m_useIphc

private

Use IPHC or HC1.

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

Referenced by DoSend(), GetTypeId(), and ReceiveFromDevice().

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

src/sixlowpan/model/sixlowpan-net-device.h
src/sixlowpan/model/sixlowpan-net-device.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Typedef Documentation

◆ DropTracedCallback

◆ FragmentKey_t

◆ FragmentsTimeoutsList_t

◆ FragmentsTimeoutsListI_t

◆ MapFragments_t

◆ MapFragmentsI_t

◆ RxTxTracedCallback

Member Enumeration Documentation

◆ DropReason

Constructor & Destructor Documentation

◆ SixLowPanNetDevice() [1/2]

◆ SixLowPanNetDevice() [2/2]

Member Function Documentation

◆ AddContext()

◆ AddLinkChangeCallback()

◆ AssignStreams()

◆ CanCompressLowPanNhc()

◆ CleanPrefix()

◆ CompressLowPanHc1()

◆ CompressLowPanIphc()

◆ CompressLowPanNhc()

◆ CompressLowPanUdpNhc()

◆ DecompressLowPanHc1()

◆ DecompressLowPanIphc()

◆ DecompressLowPanNhc()

◆ DecompressLowPanUdpNhc()

◆ DoDispose()

◆ DoFragmentation()

◆ DoSend()

◆ DropOldestFragmentSet()

◆ FindMulticastCompressionContext()

◆ FindUnicastCompressionContext()

◆ Get16MacFrom48Mac()

◆ GetAddress()

◆ GetBroadcast()

◆ GetChannel()

◆ GetContext()

◆ GetIfIndex()

◆ GetMtu()

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

◆ GetNetDevice()

◆ GetNode()

◆ GetTypeId()

◆ HandleFragmentsTimeout()

◆ HandleTimeout()

◆ InvalidateContext()

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ NeedsArp()

◆ operator=()

◆ ProcessFragment()

◆ ReceiveFromDevice()

◆ RemoveContext()

◆ RenewContext()

◆ Send()

◆ SendFrom()

◆ SetAddress()

◆ SetIfIndex()

◆ SetMtu()

◆ SetNetDevice()

◆ SetNode()

◆ SetPromiscReceiveCallback()