EMANE  1.2.1
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
EMANE::Models::CommEffect::Shim Class Reference

#include <shim.h>

Inheritance diagram for EMANE::Models::CommEffect::Shim:
EMANE::ShimLayerImplementor EMANE::NEMLayer EMANE::RadioServiceUser EMANE::Component EMANE::UpstreamTransport EMANE::DownstreamTransport EMANE::PlatformServiceUser EMANE::Buildable EMANE::RunningStateMutable EMANE::EventServiceUser EMANE::TimerServiceUser

Public Member Functions

 Shim (NEMId id, PlatformServiceProvider *pPlatformService, RadioServiceProvider *pRadioService)
 
 ~Shim () override
 
void initialize (Registrar &registrar) override
 
void configure (const ConfigurationUpdate &update) override
 
void start () override
 
void stop () override
 
void destroy () override throw ()
 
void processUpstreamControl (const ControlMessages &msgs) override
 
void processDownstreamControl (const ControlMessages &msgs) override
 
void processUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs) override
 
void processDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs) override
 
void processEvent (const EventId &, const Serialization &) override
 
void processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override
 
NEMId getNEMId () const
 
virtual void postStart ()
 
virtual void setDownstreamTransport (DownstreamTransport *pDownstreamTransport)
 
void sendDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)
 
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_
 
RadioServiceProvider * pRadioService_
 

Detailed Description

Definition at line 52 of file shim.h.

Constructor & Destructor Documentation

◆ Shim()

EMANE::Models::CommEffect::Shim::Shim ( NEMId  id,
PlatformServiceProvider *  pPlatformService,
RadioServiceProvider *  pRadioService 
)

Definition at line 86 of file shim.cc.

◆ ~Shim()

EMANE::Models::CommEffect::Shim::~Shim ( )
override

Definition at line 103 of file shim.cc.

Member Function Documentation

◆ configure()

void EMANE::Models::CommEffect::Shim::configure ( const ConfigurationUpdate &  update)
overridevirtual

Configure the component.

Parameters
updateConfiguration update values
Exceptions
ConfigureExceptionthrown when a unexpected configuration item is encountered or there is a problem with the specified item value

Implements EMANE::Component.

Definition at line 168 of file shim.cc.

◆ destroy()

void EMANE::Models::CommEffect::Shim::destroy ( )
throw (
)
overridevirtual

Destroy the component.

Implements EMANE::Component.

Definition at line 284 of file shim.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::CommEffect::Shim::initialize ( Registrar &  registrar)
overridevirtual

Initialize the component.

Exceptions
InitializeExceptionthrown when an error is encountered during initialization

Implements EMANE::Component.

Definition at line 107 of file shim.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::Application::NEMImpl, EMANE::NEMStatefulLayer, EMANE::NEMLayerStack, EMANE::Models::TDMA::BaseModel::Implementation, EMANE::Transports::Virtual::VirtualTransport, EMANE::Models::TDMA::EventScheduler, EMANE::Models::TDMA::BaseModel, EMANE::Application::NEMManagerImpl, EMANE::Models::PHYAPITest::ShimLayer, EMANE::Application::EventAgentManagerImpl, EMANE::Application::EventGeneratorManagerImpl, 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
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()

void EMANE::Models::CommEffect::Shim::processDownstreamControl ( const ControlMessages &  msgs)
overridevirtual

Process downstream control message

Parameters
msgsReference to the ControlMessages

Implements EMANE::DownstreamTransport.

Definition at line 307 of file shim.cc.

◆ processDownstreamPacket()

void EMANE::Models::CommEffect::Shim::processDownstreamPacket ( DownstreamPacket &  pkt,
const ControlMessages &  msgs 
)
overridevirtual

Process downstream packet

Parameters
pktReference to the DownstreamPacket to process
msgsoptional reference to the ControlMessages

Implements EMANE::DownstreamTransport.

Definition at line 585 of file shim.cc.

◆ processEvent()

void EMANE::Models::CommEffect::Shim::processEvent ( const EventId &  eventId,
const Serialization &  serialization 
)
overridevirtual

Process an event.

Parameters
eventIdevent identifier corresponding to the serialized event
serializationopaque event object data

Reimplemented from EMANE::EventServiceUser.

Definition at line 636 of file shim.cc.

◆ processTimedEvent()

void EMANE::Models::CommEffect::Shim::processTimedEvent ( TimerEventId  eventId,
const TimePoint &  expireTime,
const TimePoint &  scheduleTime,
const TimePoint &  fireTime,
const void *  arg 
)
overridevirtual

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 from EMANE::TimerServiceUser.

Definition at line 661 of file shim.cc.

◆ processUpstreamControl()

void EMANE::Models::CommEffect::Shim::processUpstreamControl ( const ControlMessages &  msgs)
overridevirtual

Process upstream control message

Parameters
msgsreference to the ControlMessages

Implements EMANE::UpstreamTransport.

Definition at line 296 of file shim.cc.

◆ processUpstreamPacket()

void EMANE::Models::CommEffect::Shim::processUpstreamPacket ( UpstreamPacket &  pkt,
const ControlMessages &  msgs 
)
overridevirtual

Process upstream packet

Parameters
pktreference to the UpstreamPacket to process
msgsoptional reference to the ControlMessages

Implements EMANE::UpstreamTransport.

Definition at line 318 of file shim.cc.

◆ 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::UpstreamTransport::sendDownstreamPacket ( DownstreamPacket &  pkt,
const ControlMessages &  msgs = empty 
)
inlineinherited

Send downsteam packet

Parameters
pktreference to the DownstreamPacket to process
msgsoptional reference to the ControlMessages

Definition at line 37 of file upstreamtransport.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()

void EMANE::Models::CommEffect::Shim::start ( )
overridevirtual

Start the component.

Exceptions
StartExceptionthrown when an error is encountered during start.

Implements EMANE::Component.

Definition at line 252 of file shim.cc.

◆ stop()

void EMANE::Models::CommEffect::Shim::stop ( )
overridevirtual

Stop the component.

Exceptions
StopExceptionthrown when an error is encountered during stop

Implements EMANE::Component.

Definition at line 270 of file shim.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.

◆ pRadioService_

RadioServiceProvider* EMANE::RadioServiceUser::pRadioService_
protectedinherited

Definition at line 57 of file radioserviceuser.h.

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