SatOrbiterLlc holds the orbiter implementation of LLC layer. More...

#include "satellite-orbiter-llc.h"

Inheritance diagram for ns3::SatOrbiterLlc:

Collaboration diagram for ns3::SatOrbiterLlc:

Public Types
typedef Callback< void, Ptr< Packet >, const Address & >	ReceiveSatelliteCallback
	Receive callback used for sending packet to netdevice layer. More...

Public Types inherited from ns3::SatLlc
typedef std::map< Ptr< EncapKey >, Ptr< SatBaseEncapsulator >, EncapKeyCompare >	EncapContainer_t
	Key = Ptr<EncapKey> (source, dest, flowId) Value = Ptr<SatBaseEncapsulator> Compare class = EncapKeyCompare. More...

typedef Callback< Ptr< SatControlMessage >, uint32_t >	ReadCtrlMsgCallback
	Callback to read control messages from container storing control messages. More...

typedef Callback< void, Ptr< const Packet > >	ReceiveCallback
	Receive callback used for sending packet to netdevice layer. More...

Public Member Functions
	SatOrbiterLlc ()
	Construct a SatOrbiterLlc. More...

virtual	~SatOrbiterLlc ()
	Destroy a SatOrbiterLlc. More...

virtual void	ClearQueues ()
	Remove all packets from the queues. More...

virtual bool	Enque (Ptr< Packet > packet, Address dest, uint8_t flowId)
	Called from higher layer (SatNetDevice) to enque packet to LLC. More...

virtual uint32_t	GetNBytesInQueue (Mac48Address utAddress) const
	Get the number of (new) bytes at LLC queue for a certain UT. More...

virtual uint32_t	GetNPacketsInQueue (Mac48Address utAddress) const
	Get the number of (new) packets at LLC queues for a certain UT. More...

virtual void	GetSchedulingContexts (std::vector< Ptr< SatSchedulingObject >> &output) const
	Create and fill the scheduling objects based on LLC layer information. More...

virtual Ptr< Packet >	NotifyTxOpportunity (uint32_t bytes, Mac48Address utAddr, uint8_t flowId, uint32_t &bytesLeft, uint32_t &nextMinTxO)
	Called from lower layer (MAC) to inform a Tx opportunity of certain amount of bytes. More...

virtual void	ReceiveHigherLayerPdu (Ptr< Packet > packet, Mac48Address source, Mac48Address dest)
	Receive HL PDU from encapsulator/decapsulator entity. More...

void	SetReceiveSatelliteCallback (SatOrbiterLlc::ReceiveSatelliteCallback cb)
	Set Receive callback to forward packet to upper layer on satellite. More...

Public Member Functions inherited from ns3::SatLlc
	SatLlc ()
	Construct a SatLlc. More...

virtual	~SatLlc ()
	Destroy a SatLlc. More...

void	AddDecap (Mac48Address source, Mac48Address dest, uint8_t flowId, Ptr< SatBaseEncapsulator > dec)
	Add an decapsulator entry for the LLC. More...

void	AddEncap (Mac48Address source, Mac48Address dest, uint8_t flowId, Ptr< SatBaseEncapsulator > enc)
	Add an encapsulator entry for the LLC. More...

virtual bool	BuffersEmpty () const
	Are buffers empty? More...

virtual bool	ControlBuffersEmpty () const
	Are buffers empty? More...

virtual uint32_t	GetNBytesInQueue () const
	Get the total number of (new) bytes in all encapsulators. More...

virtual uint32_t	GetNPacketsInQueue () const
	Get the total number of (new) packets in all encapsulators. More...

virtual void	Receive (Ptr< Packet > packet, Mac48Address source, Mac48Address dest)
	Receive user data packet from lower layer. More...

void	SetAdditionalHeaderSize (uint32_t additionalHeaderSize)
	Set the additional header size. More...

void	SetCtrlMsgCallback (SatBaseEncapsulator::SendCtrlCallback cb)

virtual void	SetGwAddress (Mac48Address address)
	Set the GW address. More...

virtual void	SetNodeInfo (Ptr< SatNodeInfo > nodeInfo)
	Set the node info. More...

void	SetReadCtrlCallback (SatLlc::ReadCtrlMsgCallback cb)
	Method to set read control message callback. More...

void	SetReceiveCallback (SatLlc::ReceiveCallback cb)
	Set Receive callback to forward packet to upper layer. More...

virtual void	SetSatelliteAddress (Mac48Address address)
	Set the SAT address. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Derived from Object. More...

Static Public Member Functions inherited from ns3::SatLlc
static TypeId	GetTypeId (void)
	Derived from Object. More...

Protected Member Functions
virtual void	CreateDecap (Ptr< EncapKey > key)
	Virtual method to create a new decapsulator 'on-a-need-basis' dynamically. More...

virtual void	CreateEncap (Ptr< EncapKey > key)
	Virtual method to create a new encapsulator 'on-a-need-basis' dynamically. More...

virtual void	DoDispose ()
	Dispose of this class instance. More...

Protected Member Functions inherited from ns3::SatLlc
virtual SatEnums::SatLinkDir_t	GetSatLinkRxDir ()
	Get the link RX direction. More...

virtual SatEnums::SatLinkDir_t	GetSatLinkTxDir ()
	Get the link TX direction. More...

virtual void	ReceiveAck (Ptr< SatArqAckMessage > ack, Mac48Address source, Mac48Address dest)
	Receive a control msg (ARQ ACK) from lower layer. More...

Protected Attributes
ReceiveSatelliteCallback	m_rxSatelliteCallback
	The upper layer package receive callback. More...

Protected Attributes inherited from ns3::SatLlc
uint32_t	m_additionalHeaderSize
	Additional header size to add to encapsulation/decapsulation. More...

EncapContainer_t	m_decaps
	Map of decapsulator base pointers. More...

EncapContainer_t	m_encaps
	Map of encapsulator base pointers. More...

SatEnums::RegenerationMode_t	m_forwardLinkRegenerationMode
	Regeneration mode on forward link. More...

bool	m_fwdLinkArqEnabled
	Is FWD link ARQ enabled. More...

Mac48Address	m_gwAddress
	GW address. More...

Ptr< SatNodeInfo >	m_nodeInfo
	Node info containing node related information, such as node type, node id and MAC address (of the SatNetDevice) More...

TracedCallback< Time, SatEnums::SatPacketEvent_t, SatEnums::SatNodeType_t, uint32_t, Mac48Address, SatEnums::SatLogLevel_t, SatEnums::SatLinkDir_t, std::string >	m_packetTrace
	Trace callback used for packet tracing: More...

SatLlc::ReadCtrlMsgCallback	m_readCtrlCallback
	The read control message callback. More...

SatEnums::RegenerationMode_t	m_returnLinkRegenerationMode
	Regeneration mode on return link. More...

bool	m_rtnLinkArqEnabled
	Is RTN link ARQ enabled. More...

ReceiveCallback	m_rxCallback
	The upper layer package receive callback. More...

Mac48Address	m_satelliteAddress
	SAT address, used in case of network regeneration. More...

SatBaseEncapsulator::SendCtrlCallback	m_sendCtrlCallback
	Callback to send control messages. More...

Detailed Description

SatOrbiterLlc holds the orbiter implementation of LLC layer.

SatOrbiterLlc is inherited from SatLlc base class and implements the needed changes from the base class related to SAT LLC packet transmissions and receptions.

Definition at line 40 of file satellite-orbiter-llc.h.

Member Typedef Documentation

◆ ReceiveSatelliteCallback

typedef Callback<void, Ptr<Packet>, const Address&> ns3::SatOrbiterLlc::ReceiveSatelliteCallback

Receive callback used for sending packet to netdevice layer.

Parameters

packet the packet received

Definition at line 137 of file satellite-orbiter-llc.h.

Constructor & Destructor Documentation

◆ SatOrbiterLlc()

ns3::SatOrbiterLlc::SatOrbiterLlc ( )

Construct a SatOrbiterLlc.

Definition at line 44 of file satellite-orbiter-llc.cc.

◆ ~SatOrbiterLlc()

ns3::SatOrbiterLlc::~SatOrbiterLlc ( )

virtual

Destroy a SatOrbiterLlc.

This is the destructor for the SatOrbiterLlc.

Definition at line 50 of file satellite-orbiter-llc.cc.

Member Function Documentation

◆ ClearQueues()

void ns3::SatOrbiterLlc::ClearQueues ( )

virtual

Remove all packets from the queues.

Called when performing handovers.

Definition at line 320 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_encaps.

◆ CreateDecap()

void ns3::SatOrbiterLlc::CreateDecap ( Ptr< EncapKey > key )

protectedvirtual

Virtual method to create a new decapsulator 'on-a-need-basis' dynamically.

Method is implemented in the inherited class which knows which type of decapsulator to create. This is a pure virtual method to be implemented to inherited classes.

Parameters

key	Encapsulator key class

Implements ns3::SatLlc.

Reimplemented in ns3::SatOrbiterUserLlc, and ns3::SatOrbiterFeederLlc.

Definition at line 221 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_decaps, ns3::SatLlc::m_sendCtrlCallback, and ns3::SatLlc::ReceiveHigherLayerPdu().

Here is the call graph for this function:

◆ CreateEncap()

void ns3::SatOrbiterLlc::CreateEncap ( Ptr< EncapKey > key )

protectedvirtual

Virtual method to create a new encapsulator 'on-a-need-basis' dynamically.

Method is implemented in the inherited class which knows which type of encapsulator to create. This is a pure virtual method to be implemented to inherited classes.

Parameters

key	Encapsulator key class

Implements ns3::SatLlc.

Reimplemented in ns3::SatOrbiterUserLlc, and ns3::SatOrbiterFeederLlc.

Definition at line 191 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_encaps.

Referenced by Enque().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatOrbiterLlc::DoDispose ( void )

protectedvirtual

Dispose of this class instance.

Reimplemented from ns3::SatLlc.

Reimplemented in ns3::SatOrbiterUserLlc, and ns3::SatOrbiterFeederLlc.

Definition at line 56 of file satellite-orbiter-llc.cc.

◆ Enque()

bool ns3::SatOrbiterLlc::Enque	(	Ptr< Packet >	packet,
		Address	dest,
		uint8_t	flowId
	)

virtual

Called from higher layer (SatNetDevice) to enque packet to LLC.

Parameters

packet	packet sent from above down to SatMac
dest	Destination MAC address of the packet
flowId	Flow identifier

Returns: Boolean indicating whether the enque operation succeeded

Encapsulator not found, thus create a new one. This method is implemented in the inherited classes, which knows which type of encapsulator to create.

Reimplemented from ns3::SatLlc.

Definition at line 68 of file satellite-orbiter-llc.cc.

References CreateEncap(), ns3::SatUtils::GetPacketInfo(), ns3::SatLlc::GetSatLinkTxDir(), ns3::SatEnums::LL_LLC, ns3::SatLlc::m_encaps, ns3::SatLlc::m_nodeInfo, ns3::SatLlc::m_packetTrace, and ns3::SatEnums::PACKET_ENQUE.

Here is the call graph for this function:

◆ GetNBytesInQueue()

uint32_t ns3::SatOrbiterLlc::GetNBytesInQueue ( Mac48Address utAddress ) const

virtual

Get the number of (new) bytes at LLC queue for a certain UT.

Method checks only the SatQueue for packets, thus it does not count possible packets buffered at the encapsulator (e.g. in case of ARQ). This is a pure virtual method to be implemented to inherited classes.

Parameters

utAddress the MAC address that identifies a particular UT node.

Returns: Number of bytes currently queued in the encapsulator(s) associated with the UT.

Implements ns3::SatLlc.

Definition at line 278 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_encaps.

◆ GetNPacketsInQueue()

uint32_t ns3::SatOrbiterLlc::GetNPacketsInQueue ( Mac48Address utAddress ) const

virtual

Get the number of (new) packets at LLC queues for a certain UT.

Method checks only the SatQueue for packets, thus it does not count possible packets buffered at the encapsulator (e.g. in case of ARQ). This is a pure virtual method to be implemented to inherited classes.

Parameters

utAddress the MAC address that identifies a particular UT node.

Returns: Number of packets currently queued in the encapsulator(s) associated with the UT.

Implements ns3::SatLlc.

Definition at line 299 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_encaps.

◆ GetSchedulingContexts()

void ns3::SatOrbiterLlc::GetSchedulingContexts ( std::vector< Ptr< SatSchedulingObject >> & output ) const

virtual

Create and fill the scheduling objects based on LLC layer information.

Scheduling objects may be used at the MAC layer to assist in scheduling.

Parameters

output reference to an output vector that will be filled with pointer to scheduling objects

Implements ns3::SatLlc.

Definition at line 251 of file satellite-orbiter-llc.cc.

References ns3::SatLlc::m_encaps.

◆ GetTypeId()

TypeId ns3::SatOrbiterLlc::GetTypeId ( void )

static

Derived from Object.

Definition at line 38 of file satellite-orbiter-llc.cc.

◆ NotifyTxOpportunity()

Ptr< Packet > ns3::SatOrbiterLlc::NotifyTxOpportunity	(	uint32_t	bytes,
		Mac48Address	utAddr,
		uint8_t	flowId,
		uint32_t &	bytesLeft,
		uint32_t &	nextMinTxO
	)

virtual

Called from lower layer (MAC) to inform a Tx opportunity of certain amount of bytes.

Note, that this method is not to be used in this class, but the real implementation is located in inherited classes.

Parameters

bytes	Size of the Tx opportunity
utAddr	MAC address of the UT with the Tx opportunity
flowId	Flow identifier
&bytesLeft	Bytes left after TxOpportunity
&nextMinTxO	Minimum TxO after this TxO

Returns: Pointer to packet to be transmitted

Implements ns3::SatLlc.

Definition at line 112 of file satellite-orbiter-llc.cc.

References ns3::SatUtils::GetPacketInfo(), ns3::SatEnums::LD_FORWARD, ns3::SatEnums::LL_LLC, ns3::SatLlc::m_encaps, ns3::SatLlc::m_nodeInfo, ns3::SatLlc::m_packetTrace, and ns3::SatEnums::PACKET_SENT.

Referenced by ns3::SatOrbiterHelper::AttachChannelsFeeder(), and ns3::SatOrbiterHelperDvb::AttachChannelsUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReceiveHigherLayerPdu()

void ns3::SatOrbiterLlc::ReceiveHigherLayerPdu	(	Ptr< Packet >	packet,
		Mac48Address	source,
		Mac48Address	dest
	)

virtual

Receive HL PDU from encapsulator/decapsulator entity.

Parameters

packet	Pointer to packet received.
source	MAC address of the source
dest	MAC address of the destination

Reimplemented from ns3::SatLlc.

Definition at line 154 of file satellite-orbiter-llc.cc.

References ns3::SatControlMsgTag::GetMsgId(), ns3::SatControlMsgTag::GetMsgType(), ns3::SatLlc::m_nodeInfo, ns3::SatLlc::m_readCtrlCallback, m_rxSatelliteCallback, ns3::SatLlc::ReceiveAck(), and ns3::SatControlMsgTag::SAT_ARQ_ACK.

Here is the call graph for this function:

◆ SetReceiveSatelliteCallback()

void ns3::SatOrbiterLlc::SetReceiveSatelliteCallback ( SatOrbiterLlc::ReceiveSatelliteCallback cb )

Set Receive callback to forward packet to upper layer on satellite.

Parameters

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

Definition at line 62 of file satellite-orbiter-llc.cc.

References m_rxSatelliteCallback.

Member Data Documentation

◆ m_rxSatelliteCallback

ReceiveSatelliteCallback ns3::SatOrbiterLlc::m_rxSatelliteCallback

protected

The upper layer package receive callback.

Definition at line 171 of file satellite-orbiter-llc.h.

Referenced by ReceiveHigherLayerPdu(), and SetReceiveSatelliteCallback().

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

/builds/sns3/satellite/satellite/model/satellite-orbiter-llc.h
/builds/sns3/satellite/satellite/model/satellite-orbiter-llc.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ReceiveSatelliteCallback

Constructor & Destructor Documentation

◆ SatOrbiterLlc()

◆ ~SatOrbiterLlc()

Member Function Documentation

◆ ClearQueues()

◆ CreateDecap()

◆ CreateEncap()

◆ DoDispose()

◆ Enque()

◆ GetNBytesInQueue()

◆ GetNPacketsInQueue()

◆ GetSchedulingContexts()

◆ GetTypeId()

◆ NotifyTxOpportunity()

◆ ReceiveHigherLayerPdu()

◆ SetReceiveSatelliteCallback()

Member Data Documentation

◆ m_rxSatelliteCallback