#include "satellite-point-to-point-isl-net-device.h"

Inheritance diagram for ns3::PointToPointIslNetDevice:

Collaboration diagram for ns3::PointToPointIslNetDevice:

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

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

virtual void	AddLinkChangeCallback (Callback< void > callback)

bool	Attach (Ptr< PointToPointIslChannel > ch)
	Attach the device to a channel. More...

virtual Address	GetAddress (void) const

virtual Address	GetBroadcast (void) const

virtual Ptr< Channel >	GetChannel (void) const

virtual Ptr< Node >	GetDestinationNode (void) const

virtual uint32_t	GetIfIndex (void) const

virtual uint16_t	GetMtu (void) const

virtual Address	GetMulticast (Ipv4Address multicastGroup) const

virtual Address	GetMulticast (Ipv6Address addr) const

virtual Ptr< Node >	GetNode (void) const

Ptr< DropTailQueue< Packet > >	GetQueue (void) const
	Get a copy of the attached Queue. More...

virtual bool	IsBridge (void) const

virtual bool	IsBroadcast (void) const

virtual bool	IsLinkUp (void) const

virtual bool	IsMulticast (void) const

virtual bool	IsPointToPoint (void) const

virtual bool	NeedsArp (void) const

void	Receive (Ptr< Packet > p)
	Receive a packet from a connected PointToPointIslChannel. 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)

void	SetDataRate (DataRate bps)
	Set the Data Rate used for transmission of packets. More...

virtual void	SetDestinationNode (Ptr< Node > node)

virtual void	SetIfIndex (const uint32_t index)

void	SetInterframeGap (Time t)
	Set the interframe gap used to separate packets. More...

virtual bool	SetMtu (const uint16_t mtu)

virtual void	SetNode (Ptr< Node > node)

void	SetOrbiterNetDevice (Ptr< SatOrbiterNetDevice > orbiterNetDevice)
	Set the associated OrbiterNetDevice. More...

virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)

void	SetQueue (Ptr< DropTailQueue< Packet >> queue)
	Attach a queue to the PointToPointIslNetDevice. More...

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

void	SetReceiveErrorModel (Ptr< ErrorModel > em)
	Attach a receive ErrorModel to the PointToPointIslNetDevice. More...

virtual bool	SupportsSendFrom (void) const

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the TypeId. More...

Private Types
enum	TxMachineState { READY , BUSY }
	Enumeration of the states of the transmit machine of the net device. More...

Private Member Functions
	PointToPointIslNetDevice (const PointToPointIslNetDevice &o)
	Copy constructor. More...

void	AddHeader (Ptr< Packet > p, uint16_t protocolNumber)
	Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent. More...

virtual void	DoDispose (void)
	Dispose of the object. More...

Address	GetRemote (void) const

void	NotifyLinkUp (void)
	Make the link up and running. More...

PointToPointIslNetDevice &	operator= (const PointToPointIslNetDevice &o)
	Assign operator. More...

bool	ProcessHeader (Ptr< Packet > p, uint16_t &param)
	Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent. More...

void	TransmitComplete (void)
	Stop Sending a Packet Down the Wire and Begin the Interframe Gap. More...

bool	TransmitStart (Ptr< Packet > p)
	Start Sending a Packet Down the Wire. More...

Static Private Member Functions
static uint16_t	EtherToPpp (uint16_t protocol)
	Ethernet to PPP protocol number mapping. More...

static uint16_t	PppToEther (uint16_t protocol)
	PPP to Ethernet protocol number mapping. More...

Private Attributes
Mac48Address	m_address
	Mac48Address of this NetDevice. More...

Ptr< PointToPointIslChannel >	m_channel
	The PointToPointIslChannel to which this PointToPointIslNetDevice has been attached. More...

Ptr< Packet >	m_currentPkt
	Current packet processed. More...

DataRate	m_dataRate
	The data rate that the Net Device uses to simulate packet transmission timing. More...

Ptr< Node >	m_destinationNode
	Node at the other end of the p2pIslLink. More...

uint32_t	m_ifIndex
	Index of the interface. More...

bool	m_linkUp
	Identify if the link is up or not. More...

uint32_t	m_mtu
	The Maximum Transmission Unit. More...

Ptr< Node >	m_node
	Node owning this NetDevice. More...

Ptr< SatOrbiterNetDevice >	m_orbiterNetDevice
	Satellite Orbiter Net Device associated to this instance. More...

TracedCallback< uint32_t, Ptr< Node >, Ptr< Node >, bool >	m_packetDropRateTrace
	Traced callback for drop rate in queue. More...

NetDevice::PromiscReceiveCallback	m_promiscCallback
	Receive callback. More...

Ptr< DropTailQueue< Packet > >	m_queue
	The Queue which this PointToPointIslNetDevice uses as a packet source. More...

Ptr< ErrorModel >	m_receiveErrorModel
	Error model for receive packet events. More...

NetDevice::ReceiveCallback	m_rxCallback
	Receive callback. More...

Time	m_tInterframeGap
	The interframe gap that the Net Device uses to throttle packet transmission. More...

TxMachineState	m_txMachineState
	The state of the Net Device transmit state machine. More...

Static Private Attributes
static const uint16_t	DEFAULT_MTU = 1500
	Default MTU. More...

Detailed Description

Definition at line 66 of file satellite-point-to-point-isl-net-device.h.

Member Enumeration Documentation

◆ TxMachineState

enum ns3::PointToPointIslNetDevice::TxMachineState

private

Enumeration of the states of the transmit machine of the net device.

Enumerator
READY	The transmitter is ready to begin transmission of a packet.
BUSY	The transmitter is busy transmitting a packet.

Definition at line 291 of file satellite-point-to-point-isl-net-device.h.

Constructor & Destructor Documentation

◆ PointToPointIslNetDevice() [1/2]

ns3::PointToPointIslNetDevice::PointToPointIslNetDevice ( )

Construct a PointToPointIslNetDevice.

This is the constructor for the PointToPointIslNetDevice

Definition at line 74 of file satellite-point-to-point-isl-net-device.cc.

◆ ~PointToPointIslNetDevice()

ns3::PointToPointIslNetDevice::~PointToPointIslNetDevice ( )

virtual

Destroy a PointToPointIslNetDevice.

This is the destructor for the PointToPointIslNetDevice.

Definition at line 83 of file satellite-point-to-point-isl-net-device.cc.

◆ PointToPointIslNetDevice() [2/2]

ns3::PointToPointIslNetDevice::PointToPointIslNetDevice ( const PointToPointIslNetDevice & o )

private

Copy constructor.

The method is private, so it is DISABLED.

Parameters

o	Other NetDevice

Member Function Documentation

◆ AddHeader()

void ns3::PointToPointIslNetDevice::AddHeader	(	Ptr< Packet >	p,
		uint16_t	protocolNumber
	)

private

Adds the necessary headers and trailers to a packet of data in order to respect the protocol implemented by the agent.

Parameters

p	packet
protocolNumber	protocol number

Definition at line 89 of file satellite-point-to-point-isl-net-device.cc.

References EtherToPpp().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddLinkChangeCallback()

void ns3::PointToPointIslNetDevice::AddLinkChangeCallback ( Callback< void > callback )

virtual

Definition at line 338 of file satellite-point-to-point-isl-net-device.cc.

◆ Attach()

bool ns3::PointToPointIslNetDevice::Attach ( Ptr< PointToPointIslChannel > ch )

Attach the device to a channel.

Parameters

ch	Ptr to the channel to which this object is being attached.

Returns: true if the operation was successful (always true actually)

Definition at line 188 of file satellite-point-to-point-isl-net-device.cc.

References m_channel, and NotifyLinkUp().

Here is the call graph for this function:

◆ DoDispose()

void ns3::PointToPointIslNetDevice::DoDispose ( void )

privatevirtual

Dispose of the object.

Definition at line 108 of file satellite-point-to-point-isl-net-device.cc.

References m_channel, m_currentPkt, m_node, m_queue, and m_receiveErrorModel.

◆ EtherToPpp()

uint16_t ns3::PointToPointIslNetDevice::EtherToPpp ( uint16_t protocol )

staticprivate

Ethernet to PPP protocol number mapping.

Parameters

protocol An Ethernet protocol number

Returns: The corresponding PPP protocol number

Definition at line 539 of file satellite-point-to-point-isl-net-device.cc.

Referenced by AddHeader().

Here is the caller graph for this function:

◆ GetAddress()

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

virtual

Definition at line 312 of file satellite-point-to-point-isl-net-device.cc.

References m_address.

Referenced by Receive().

Here is the caller graph for this function:

◆ GetBroadcast()

Address ns3::PointToPointIslNetDevice::GetBroadcast ( void ) const

virtual

Definition at line 360 of file satellite-point-to-point-isl-net-device.cc.

◆ GetChannel()

Ptr< Channel > ns3::PointToPointIslNetDevice::GetChannel ( void ) const

virtual

Definition at line 293 of file satellite-point-to-point-isl-net-device.cc.

References m_channel.

◆ GetDestinationNode()

Ptr< Node > ns3::PointToPointIslNetDevice::GetDestinationNode ( void ) const

virtual

Definition at line 325 of file satellite-point-to-point-isl-net-device.cc.

References m_destinationNode.

◆ GetIfIndex()

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

virtual

Definition at line 287 of file satellite-point-to-point-isl-net-device.cc.

References m_ifIndex.

◆ GetMtu()

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

virtual

Definition at line 516 of file satellite-point-to-point-isl-net-device.cc.

References m_mtu.

◆ GetMulticast() [1/2]

Address ns3::PointToPointIslNetDevice::GetMulticast ( Ipv4Address multicastGroup ) const

virtual

Definition at line 374 of file satellite-point-to-point-isl-net-device.cc.

◆ GetMulticast() [2/2]

Address ns3::PointToPointIslNetDevice::GetMulticast ( Ipv6Address addr ) const

virtual

Definition at line 381 of file satellite-point-to-point-isl-net-device.cc.

◆ GetNode()

Ptr< Node > ns3::PointToPointIslNetDevice::GetNode ( void ) const

virtual

Definition at line 451 of file satellite-point-to-point-isl-net-device.cc.

References m_node.

◆ GetQueue()

Ptr< DropTailQueue< Packet > > ns3::PointToPointIslNetDevice::GetQueue ( void ) const

Get a copy of the attached Queue.

Returns: Ptr to the queue.

Definition at line 266 of file satellite-point-to-point-isl-net-device.cc.

References m_queue.

◆ GetRemote()

Address ns3::PointToPointIslNetDevice::GetRemote ( void ) const

private

Returns: the address of the remote device connected to this device through the point to point channel.

Definition at line 490 of file satellite-point-to-point-isl-net-device.cc.

References m_channel.

Referenced by Receive().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::PointToPointIslNetDevice::GetTypeId ( void )

static

Get the TypeId.

Returns: The TypeId for this class

Definition at line 50 of file satellite-point-to-point-isl-net-device.cc.

References m_packetDropRateTrace, m_receiveErrorModel, and m_tInterframeGap.

◆ IsBridge()

bool ns3::PointToPointIslNetDevice::IsBridge ( void ) const

virtual

Definition at line 395 of file satellite-point-to-point-isl-net-device.cc.

◆ IsBroadcast()

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

virtual

Definition at line 348 of file satellite-point-to-point-isl-net-device.cc.

◆ IsLinkUp()

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

virtual

Definition at line 331 of file satellite-point-to-point-isl-net-device.cc.

References m_linkUp.

Referenced by Send().

Here is the caller graph for this function:

◆ IsMulticast()

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

virtual

Definition at line 367 of file satellite-point-to-point-isl-net-device.cc.

◆ IsPointToPoint()

bool ns3::PointToPointIslNetDevice::IsPointToPoint ( void ) const

virtual

Definition at line 388 of file satellite-point-to-point-isl-net-device.cc.

◆ NeedsArp()

bool ns3::PointToPointIslNetDevice::NeedsArp ( void ) const

virtual

Definition at line 464 of file satellite-point-to-point-isl-net-device.cc.

◆ NotifyLinkUp()

void ns3::PointToPointIslNetDevice::NotifyLinkUp ( void )

private

Make the link up and running.

It calls also the linkChange callback.

Definition at line 273 of file satellite-point-to-point-isl-net-device.cc.

References m_linkUp.

Referenced by Attach().

Here is the caller graph for this function:

◆ operator=()

PointToPointIslNetDevice& ns3::PointToPointIslNetDevice::operator= ( const PointToPointIslNetDevice & o )

private

Assign operator.

The method is private, so it is DISABLED.

Parameters

o	Other NetDevice

Returns: New instance of the NetDevice

◆ PppToEther()

uint16_t ns3::PointToPointIslNetDevice::PppToEther ( uint16_t protocol )

staticprivate

PPP to Ethernet protocol number mapping.

Parameters

protocol A PPP protocol number

Returns: The corresponding Ethernet protocol number

Definition at line 523 of file satellite-point-to-point-isl-net-device.cc.

Referenced by ProcessHeader().

Here is the caller graph for this function:

◆ ProcessHeader()

bool ns3::PointToPointIslNetDevice::ProcessHeader	(	Ptr< Packet >	p,
		uint16_t &	param
	)

private

Removes, from a packet of data, all headers and trailers that relate to the protocol implemented by the agent.

Parameters

p	Packet whose headers need to be processed
param	An integer parameter that can be set by the function

Returns: Returns true if the packet should be forwarded up the protocol stack.

Definition at line 98 of file satellite-point-to-point-isl-net-device.cc.

References PppToEther().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Receive()

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

Receive a packet from a connected PointToPointIslChannel.

The PointToPointIslNetDevice receives packets from its connected channel and forwards them up the protocol stack. This is the public method used by the channel to indicate that the last bit of a packet has arrived at the device.

Parameters

p	Ptr to the received packet.

Definition at line 220 of file satellite-point-to-point-isl-net-device.cc.

References GetAddress(), ns3::SatGroundStationAddressTag::GetGroundStationAddress(), GetRemote(), m_orbiterNetDevice, m_promiscCallback, m_receiveErrorModel, and ProcessHeader().

Referenced by ns3::PointToPointIslChannel::TransmitStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

bool ns3::PointToPointIslNetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Definition at line 402 of file satellite-point-to-point-isl-net-device.cc.

References AddHeader(), IsLinkUp(), m_destinationNode, m_node, m_packetDropRateTrace, m_queue, m_txMachineState, READY, and TransmitStart().

Here is the call graph for this function:

◆ SendFrom()

bool ns3::PointToPointIslNetDevice::SendFrom	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber
	)

virtual

Definition at line 441 of file satellite-point-to-point-isl-net-device.cc.

◆ SetAddress()

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

virtual

Definition at line 305 of file satellite-point-to-point-isl-net-device.cc.

References m_address.

Referenced by ns3::PointToPointIslHelper::Install().

Here is the caller graph for this function:

◆ SetDataRate()

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

Set the Data Rate used for transmission of packets.

The data rate is set in the Attach () method from the corresponding field in the channel to which the device is attached. It can be overridden using this method.

Parameters

bps	the data rate at which this object operates

Definition at line 120 of file satellite-point-to-point-isl-net-device.cc.

References m_dataRate.

◆ SetDestinationNode()

void ns3::PointToPointIslNetDevice::SetDestinationNode ( Ptr< Node > node )

virtual

Definition at line 318 of file satellite-point-to-point-isl-net-device.cc.

References m_destinationNode.

◆ SetIfIndex()

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

virtual

Definition at line 280 of file satellite-point-to-point-isl-net-device.cc.

References m_ifIndex.

◆ SetInterframeGap()

void ns3::PointToPointIslNetDevice::SetInterframeGap ( Time t )

Set the interframe gap used to separate packets.

The interframe gap defines the minimum space required between packets sent by this device.

Parameters

t	the interframe gap time

Definition at line 127 of file satellite-point-to-point-isl-net-device.cc.

References m_tInterframeGap.

◆ SetMtu()

bool ns3::PointToPointIslNetDevice::SetMtu ( const uint16_t mtu )

virtual

Definition at line 508 of file satellite-point-to-point-isl-net-device.cc.

References m_mtu.

◆ SetNode()

void ns3::PointToPointIslNetDevice::SetNode ( Ptr< Node > node )

virtual

Definition at line 457 of file satellite-point-to-point-isl-net-device.cc.

References m_node.

◆ SetOrbiterNetDevice()

void ns3::PointToPointIslNetDevice::SetOrbiterNetDevice ( Ptr< SatOrbiterNetDevice > orbiterNetDevice )

Set the associated OrbiterNetDevice.

Parameters

orbiterNetDevice The device to attach to this instance

Definition at line 258 of file satellite-point-to-point-isl-net-device.cc.

References m_orbiterNetDevice.

◆ SetPromiscReceiveCallback()

void ns3::PointToPointIslNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback cb )

virtual

Definition at line 477 of file satellite-point-to-point-isl-net-device.cc.

References m_promiscCallback.

◆ SetQueue()

void ns3::PointToPointIslNetDevice::SetQueue ( Ptr< DropTailQueue< Packet >> queue )

Attach a queue to the PointToPointIslNetDevice.

The PointToPointIslNetDevice "owns" a queue that implements a queueing method such as DropTailQueue or RedQueue

Parameters

queue Ptr to the new queue.

Definition at line 206 of file satellite-point-to-point-isl-net-device.cc.

References m_queue.

◆ SetReceiveCallback()

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

virtual

Definition at line 471 of file satellite-point-to-point-isl-net-device.cc.

References m_rxCallback.

◆ SetReceiveErrorModel()

void ns3::PointToPointIslNetDevice::SetReceiveErrorModel ( Ptr< ErrorModel > em )

Attach a receive ErrorModel to the PointToPointIslNetDevice.

The PointToPointNetLaserDevice may optionally include an ErrorModel in the packet receive chain.

Parameters

em	Ptr to the ErrorModel.

Definition at line 213 of file satellite-point-to-point-isl-net-device.cc.

References m_receiveErrorModel.

◆ SupportsSendFrom()

bool ns3::PointToPointIslNetDevice::SupportsSendFrom ( void ) const

virtual

Definition at line 483 of file satellite-point-to-point-isl-net-device.cc.

◆ TransmitComplete()

void ns3::PointToPointIslNetDevice::TransmitComplete ( void )

private

Stop Sending a Packet Down the Wire and Begin the Interframe Gap.

The TransmitComplete method is used internally to finish the process of sending a packet out on the channel.

Definition at line 159 of file satellite-point-to-point-isl-net-device.cc.

References BUSY, m_currentPkt, m_queue, m_txMachineState, READY, and TransmitStart().

Referenced by TransmitStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransmitStart()

bool ns3::PointToPointIslNetDevice::TransmitStart ( Ptr< Packet > p )

private

Start Sending a Packet Down the Wire.

The TransmitStart method is the method that is used internally in the PointToPointIslNetDevice to begin the process of sending a packet out on the channel. The corresponding method is called on the channel to let it know that the physical device this class represents has virtually started sending signals. An event is scheduled for the time at which the bits have been completely transmitted.