EMANE  1.2.1
EMANE::PHYLayerImplementor Class Referenceabstract

Interface used to create a PHY layer plugin implementation. More...

#include <phylayerimpl.h>

Inheritance diagram for EMANE::PHYLayerImplementor:
EMANE::NEMLayer EMANE::Component EMANE::UpstreamTransport EMANE::DownstreamTransport EMANE::PlatformServiceUser EMANE::Buildable EMANE::RunningStateMutable EMANE::EventServiceUser EMANE::TimerServiceUser EMANE::FrameworkPHY EMANE::Models::Bypass::PHYLayer

Public Member Functions

virtual ~PHYLayerImplementor ()
 
virtual void processUpstreamPacket (const CommonPHYHeader &hdr, UpstreamPacket &pkt, const ControlMessages &msgs=UpstreamTransport::empty)=0
 
void sendDownstreamPacket (const CommonPHYHeader &hdr, DownstreamPacket &pkt, const ControlMessages &msgs=DownstreamTransport::empty)
 
NEMId getNEMId () const
 
virtual void initialize (Registrar &registrar)=0
 
virtual void configure (const ConfigurationUpdate &update)=0
 
virtual void start ()=0
 
virtual void postStart ()
 
virtual void stop ()=0
 
virtual void destroy ()=0 throw ()
 
virtual void setDownstreamTransport (DownstreamTransport *pDownstreamTransport)
 
void sendDownstreamControl (const ControlMessages &msgs)
 
virtual void processDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)=0
 
virtual void processDownstreamControl (const ControlMessages &msgs)=0
 
virtual void setUpstreamTransport (UpstreamTransport *pUpstreamTransport)
 
void sendUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)
 
void sendUpstreamControl (const ControlMessages &msgs)
 
virtual void processEvent (const EventId &eventId, const Serialization &serialization)
 
virtual void processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg)
 
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 Member Functions

 PHYLayerImplementor (NEMId id, PlatformServiceProvider *p)
 

Protected Attributes

NEMId id_
 
PlatformServiceProviderpPlatformService_
 

Detailed Description

Interface used to create a PHY layer plugin implementation.

Deprecated:
For almost all use cases physical layer plugin creation should be avoided in favor of using the emulator's physical layer.
Attention
Need additional features added to the emulator's physical layer? Send an email to emane-info at adjacentlink dot com.

Definition at line 53 of file phylayerimpl.h.

Constructor & Destructor Documentation

◆ ~PHYLayerImplementor()

virtual EMANE::PHYLayerImplementor::~PHYLayerImplementor ( )
inlinevirtual

Definition at line 56 of file phylayerimpl.h.

◆ PHYLayerImplementor()

EMANE::PHYLayerImplementor::PHYLayerImplementor ( NEMId  id,
PlatformServiceProvider p 
)
inlineprotected

Definition at line 88 of file phylayerimpl.h.

Member Function Documentation

◆ configure()

◆ destroy()

◆ 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()

◆ postStart()

◆ processConfiguration()

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

Process dynamic running-state configuration updates

Parameters
updateConfiguration 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()

◆ processDownstreamPacket()

◆ processEvent()

virtual void EMANE::EventServiceUser::processEvent ( const EventId eventId,
const Serialization serialization 
)
inlinevirtualinherited

◆ processTimedEvent()

virtual void EMANE::TimerServiceUser::processTimedEvent ( TimerEventId  eventId,
const TimePoint expireTime,
const TimePoint scheduleTime,
const TimePoint fireTime,
const void *  arg 
)
inlinevirtualinherited

Process a timed event

Parameters
eventIdIdentifier corresponding to the timer being processed
expireTimeThe time the timer was scheduled to expire
scheduleTimeThe Time the timer was scheduled
fireTimeTime time The time the timer actually fired
argOpaque timed event data
Note
All times are abosulte using CLOCK_REALTIME

Reimplemented in EMANE::NEMStatefulLayer, EMANE::Models::Bypass::PHYLayer, EMANE::NEMQueuedLayer, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Models::CommEffect::Shim, EMANE::Agents::GPSDLocation::Agent, EMANE::TimerServiceProxy, and EMANE::NEMTimerServiceProxy.

Definition at line 62 of file timerserviceuser.h.

◆ processUpstreamPacket()

virtual void EMANE::PHYLayerImplementor::processUpstreamPacket ( const CommonPHYHeader hdr,
UpstreamPacket pkt,
const ControlMessages msgs = UpstreamTransport::empty 
)
pure virtual

Process an upstream packet

Parameters
hdrPHY message header
pktUpstream packet reference
msgsOptional control messages
Note
Control message ownership is transferred with this call. Control messages should not be accessed after this point.

Implemented in EMANE::Models::Bypass::PHYLayer, and EMANE::FrameworkPHY.

◆ sendDownstreamControl()

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

Send downstream control message

Parameters
msgsreference 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 
)
inline

Sends a downstream packet

Parameters
hdrPHY message header
pktDownstream packet reference
msgsOptional 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
msgsReference 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
pktReference to the UpstreamPacket to process
msgsoptional 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
bidthe 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
pDownstreamTransportPointer 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
pUpstreamTransportPointer 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()

◆ stop()

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: