Implementation of the bypass PHY layer. More...

#include <phylayer.h>

Inheritance diagram for EMANE::Models::Bypass::PHYLayer:

Public Member Functions
	PHYLayer (NEMId id, PlatformServiceProvider *pPlatformService)
	constructor More...

	~PHYLayer ()
	destructor More...

void	initialize (Registrar &registrar) override

void	configure (const ConfigurationUpdate &update) override

void	start () override

void	stop () override

void	destroy () override throw ()

void	processUpstreamPacket (const CommonPHYHeader &hdr, UpstreamPacket &pkt, const ControlMessages &msgs) override

void	processDownstreamControl (const ControlMessages &msgs) override

void	processDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs) override

void	processEvent (const EventId &id, const Serialization &serialization) override

void	processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override

void	sendDownstreamPacket (const CommonPHYHeader &hdr, DownstreamPacket &pkt, const ControlMessages &msgs=DownstreamTransport::empty)

NEMId	getNEMId () const

virtual void	postStart ()

virtual void	setDownstreamTransport (DownstreamTransport *pDownstreamTransport)

void	sendDownstreamControl (const ControlMessages &msgs)

virtual void	setUpstreamTransport (UpstreamTransport *pUpstreamTransport)

void	sendUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)

void	sendUpstreamControl (const ControlMessages &msgs)

BuildId	getBuildId () const

void	setBuildId (BuildId bid)

virtual void	processConfiguration (const ConfigurationUpdate &update)

Static Public Attributes
static const ControlMessages	empty

static const ControlMessages	empty

Protected Attributes
NEMId	id_

PlatformServiceProvider *	pPlatformService_

Detailed Description

Implementation of the bypass PHY layer.

Definition at line 53 of file models/phy/bypass/phylayer.h.

Constructor & Destructor Documentation

◆ PHYLayer()

EMANE::Models::Bypass::PHYLayer::PHYLayer	(	NEMId	id,
		PlatformServiceProvider *	pPlatformService
	)

constructor

Definition at line 38 of file models/phy/bypass/phylayer.cc.

◆ ~PHYLayer()

EMANE::Models::Bypass::PHYLayer::~PHYLayer ( )

destructor

Definition at line 44 of file models/phy/bypass/phylayer.cc.

Member Function Documentation

◆ configure()

void EMANE::Models::Bypass::PHYLayer::configure ( const ConfigurationUpdate & update )

overridevirtual

Configure the component.

Parameters

update Configuration update values

Exceptions

ConfigureException thrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implements EMANE::Component.

Definition at line 115 of file models/phy/bypass/phylayer.cc.

◆ destroy()

void EMANE::Models::Bypass::PHYLayer::destroy	(	)
throw	(
	)

overridevirtual

Destroy the component.

Implements EMANE::Component.

Definition at line 147 of file models/phy/bypass/phylayer.cc.

◆ getBuildId()

EMANE::BuildId EMANE::Buildable::getBuildId ( ) const

inlineinherited

Gets the application wide unique BuildId of this object.

Returns: the BuildId

Definition at line 34 of file buildable.inl.

◆ getNEMId()

NEMId EMANE::NEMLayer::getNEMId ( ) const

inlineinherited

Get the NEM identifier.

Returns: NEM identifier

Definition at line 72 of file nemlayer.h.

◆ initialize()

void EMANE::Models::Bypass::PHYLayer::initialize ( Registrar & registrar )

overridevirtual

Initialize the component.

Exceptions

InitializeException thrown when an error is encountered during initialization

Implements EMANE::Component.

Definition at line 104 of file models/phy/bypass/phylayer.cc.

◆ postStart()

virtual void EMANE::Component::postStart ( )

inlinevirtualinherited

Hook to run any post start functionaililty. Called after all the components have been started.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Application::NEMImpl, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, EMANE::Application::NEMManagerImpl, EMANE::ShimLayer, EMANE::Application::TransportAdapterImpl, EMANE::MACLayer, EMANE::PHYLayer, EMANE::TransportLayer, EMANE::Application::TransportManagerImpl, and EMANE::Models::TDMA::BasicQueueManager.

Definition at line 119 of file component.h.

◆ processConfiguration()

virtual void EMANE::RunningStateMutable::processConfiguration ( const ConfigurationUpdate & update )

inlinevirtualinherited

Process dynamic running-state configuration updates

Parameters

update Configuration update

Note: Running state configuration errors are indicated using a validator. Validators can be registered using the ConfigurationRegistrar.

Reimplemented in EMANE::Models::IEEE80211ABG::MACLayer, EMANE::Models::RFPipe::MACLayer, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Models::TDMA::BaseModel, EMANE::NEMStatefulLayer, EMANE::NEMQueuedLayer, and EMANE::FrameworkPHY.

Definition at line 63 of file runningstatemutable.h.

◆ processDownstreamControl()

void EMANE::Models::Bypass::PHYLayer::processDownstreamControl ( const ControlMessages & msgs )

overridevirtual

Process downstream control message

Parameters

msgs	Reference to the ControlMessages

Implements EMANE::DownstreamTransport.

Definition at line 47 of file models/phy/bypass/phylayer.cc.

◆ processDownstreamPacket()

void EMANE::Models::Bypass::PHYLayer::processDownstreamPacket	(	DownstreamPacket &	pkt,
		const ControlMessages &	msgs
	)

overridevirtual

Process downstream packet

Parameters

pkt	Reference to the DownstreamPacket to process
msgs	optional reference to the ControlMessages

Implements EMANE::DownstreamTransport.

Definition at line 56 of file models/phy/bypass/phylayer.cc.

◆ processEvent()

void EMANE::Models::Bypass::PHYLayer::processEvent	(	const EventId &	eventId,
		const Serialization &	serialization
	)

overridevirtual

Process an event.

Parameters

eventId	event identifier corresponding to the serialized event
serialization	opaque event object data

Reimplemented from EMANE::EventServiceUser.

Definition at line 157 of file models/phy/bypass/phylayer.cc.

◆ processTimedEvent()

void EMANE::Models::Bypass::PHYLayer::processTimedEvent	(	TimerEventId	eventId,
		const TimePoint &	expireTime,
		const TimePoint &	scheduleTime,
		const TimePoint &	fireTime,
		const void *	arg
	)

overridevirtual

Process a timed event

Parameters

eventId	Identifier corresponding to the timer being processed
expireTime	The time the timer was scheduled to expire
scheduleTime	The Time the timer was scheduled
fireTime	Time time The time the timer actually fired
arg	Opaque timed event data

Note: All times are abosulte using CLOCK_REALTIME

Reimplemented from EMANE::TimerServiceUser.

Definition at line 167 of file models/phy/bypass/phylayer.cc.

◆ processUpstreamPacket()

void EMANE::Models::Bypass::PHYLayer::processUpstreamPacket	(	const CommonPHYHeader &	hdr,
		UpstreamPacket &	pkt,
		const ControlMessages &	msgs
	)

overridevirtual

Process an upstream packet

Parameters

hdr	PHY message header
pkt	Upstream packet reference
msgs	Optional control messages

Note: Control message ownership is transferred with this call. Control messages should not be accessed after this point.

Implements EMANE::PHYLayerImplementor.

Definition at line 84 of file models/phy/bypass/phylayer.cc.

◆ sendDownstreamControl()

void EMANE::UpstreamTransport::sendDownstreamControl ( const ControlMessages & msgs )

inlineinherited

Send downstream control message

Parameters

msgs	reference to the ControlMessages

Definition at line 44 of file upstreamtransport.inl.

◆ sendDownstreamPacket()

void EMANE::PHYLayerImplementor::sendDownstreamPacket	(	const CommonPHYHeader &	hdr,
		DownstreamPacket &	pkt,
		const ControlMessages &	msgs = `DownstreamTransport::empty`
	)

inlineinherited

Sends a downstream packet

Parameters

hdr	PHY message header
pkt	Downstream packet reference
msgs	Optional control messages

Note: Control message ownership is transferred with this call. Control messages should not be accessed after this point.

Definition at line 35 of file phylayerimpl.inl.

◆ sendUpstreamControl()

void EMANE::DownstreamTransport::sendUpstreamControl ( const ControlMessages & msgs )

inlineinherited

Send upstream control message

Parameters

msgs	Reference to the ControlMessages

Definition at line 44 of file downstreamtransport.inl.

◆ sendUpstreamPacket()

void EMANE::DownstreamTransport::sendUpstreamPacket	(	UpstreamPacket &	pkt,
		const ControlMessages &	msgs = `empty`
	)

inlineinherited

Send upstream packet

Parameters

pkt	Reference to the UpstreamPacket to process
msgs	optional reference to the ControlMessages

Definition at line 37 of file downstreamtransport.inl.

◆ setBuildId()

void EMANE::Buildable::setBuildId ( BuildId bid )

inlineinherited

Sets the application wide unique BuildId of this object. Builders assign a BuildId to objects at instantiation.

Parameters

bid	the BuildId

Note: : This method is for internal framework use only.

Definition at line 40 of file buildable.inl.

◆ setDownstreamTransport()

virtual void EMANE::UpstreamTransport::setDownstreamTransport ( DownstreamTransport * pDownstreamTransport )

inlinevirtualinherited

Set the downstream transport.

Parameters

pDownstreamTransport Pointer to the downstream transport of this upstream transport.

Note: : This method is for internal framework use only.

Reimplemented in EMANE::NEMStatefulLayer, EMANE::PHYLayer, EMANE::MACLayer, EMANE::ShimLayer, and EMANE::TransportLayer.

Definition at line 82 of file upstreamtransport.h.

◆ setUpstreamTransport()

virtual void EMANE::DownstreamTransport::setUpstreamTransport ( UpstreamTransport * pUpstreamTransport )

inlinevirtualinherited

Set the upstream transport.

Parameters

pUpstreamTransport Pointer to the upstream transport of this downstream transport.

Reimplemented in EMANE::NEMStatefulLayer, EMANE::MACLayer, EMANE::ShimLayer, EMANE::PHYLayer, and EMANE::TransportLayer.

Definition at line 79 of file downstreamtransport.h.

◆ start()

void EMANE::Models::Bypass::PHYLayer::start ( )

overridevirtual

Start the component.

Exceptions

StartException thrown when an error is encountered during start.

Implements EMANE::Component.

Definition at line 129 of file models/phy/bypass/phylayer.cc.

◆ stop()

void EMANE::Models::Bypass::PHYLayer::stop ( )

overridevirtual

Stop the component.

Exceptions

StopException thrown when an error is encountered during stop

Implements EMANE::Component.

Definition at line 138 of file models/phy/bypass/phylayer.cc.

Member Data Documentation

◆ empty [1/2]

const EMANE::ControlMessages EMANE::DownstreamTransport::empty

staticinherited

Definition at line 102 of file downstreamtransport.h.

◆ empty [2/2]

const EMANE::ControlMessages EMANE::UpstreamTransport::empty

staticinherited

Definition at line 106 of file upstreamtransport.h.

◆ id_

NEMId EMANE::NEMLayer::id_

protectedinherited

Definition at line 81 of file nemlayer.h.

◆ pPlatformService_

PlatformServiceProvider* EMANE::PlatformServiceUser::pPlatformService_

protectedinherited

Definition at line 64 of file platformserviceuser.h.

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

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PHYLayer()

◆ ~PHYLayer()

Member Function Documentation

◆ configure()

◆ destroy()

◆ getBuildId()

◆ getNEMId()

◆ initialize()

◆ postStart()

◆ processConfiguration()

◆ processDownstreamControl()

◆ processDownstreamPacket()

◆ processEvent()

◆ processTimedEvent()

◆ processUpstreamPacket()

◆ sendDownstreamControl()

◆ sendDownstreamPacket()

◆ sendUpstreamControl()

◆ sendUpstreamPacket()

◆ setBuildId()

◆ setDownstreamTransport()

◆ setUpstreamTransport()

◆ start()

◆ stop()

Member Data Documentation

◆ empty [1/2]

◆ empty [2/2]

◆ id_

◆ pPlatformService_