EMANE  1.2.1
EMANE::MACLayer Class Reference

Bridge for the MAC NEM layer. Decouples a MACLayerImplementor implementation from the NEM to allow for interface modification and encapsulation. More...

#include <maclayer.h>

Inheritance diagram for EMANE::MACLayer:
EMANE::NEMQueuedLayer EMANE::NEMLayer EMANE::FileDescriptorServiceProvider EMANE::Component EMANE::UpstreamTransport EMANE::DownstreamTransport EMANE::PlatformServiceUser EMANE::Buildable EMANE::RunningStateMutable EMANE::EventServiceUser EMANE::TimerServiceUser

Public Types

enum  DescriptorType { DescriptorType::READ, DescriptorType::WRITE }
 

Public Member Functions

 MACLayer (NEMId id, NEMLayer *pImplementor, PlatformServiceProvider *pPlatformService)
 
 ~MACLayer ()
 
void initialize (Registrar &registrar) override
 
void configure (const ConfigurationUpdate &update) override
 
void start () override
 
void postStart () override
 
void stop () override
 
void destroy () override throw ()
 
void setDownstreamTransport (DownstreamTransport *) override
 
void setUpstreamTransport (UpstreamTransport *) override
 
void processConfiguration (const ConfigurationUpdate &update) override
 
void processDownstreamControl (const ControlMessages &msgs) override
 
void processDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs) override
 
void processUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs) override
 
void processUpstreamControl (const ControlMessages &msgs) override
 
void processEvent (const EventId &eventId, const Serialization &serialization) override
 
void processTimedEvent (TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg) override
 
template<typename Function >
void processTimer (Function fn, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime)
 
NEMId getNEMId () const
 
void sendDownstreamPacket (DownstreamPacket &pkt, const ControlMessages &msgs=empty)
 
void sendDownstreamControl (const ControlMessages &msgs)
 
void sendUpstreamPacket (UpstreamPacket &pkt, const ControlMessages &msgs=empty)
 
void sendUpstreamControl (const ControlMessages &msgs)
 
BuildId getBuildId () const
 
void setBuildId (BuildId bid)
 
template<typename Function >
void addFileDescriptor (int iFd, DescriptorType type, Function fn)
 

Static Public Attributes

static const ControlMessages empty
 
static const ControlMessages empty
 

Protected Types

using Callback = std::function< void(int iFd)>
 

Protected Attributes

NEMId id_
 

Detailed Description

Bridge for the MAC NEM layer. Decouples a MACLayerImplementor implementation from the NEM to allow for interface modification and encapsulation.

Definition at line 51 of file libemane/maclayer.h.

Member Typedef Documentation

◆ Callback

using EMANE::FileDescriptorServiceProvider::Callback = std::function<void(int iFd)>
protectedinherited

Definition at line 83 of file filedescriptorserviceprovider.h.

Member Enumeration Documentation

◆ DescriptorType

Enumerator
READ 

Process when data is ready to read

WRITE 

Process when data is ready to write

Definition at line 53 of file filedescriptorserviceprovider.h.

Constructor & Destructor Documentation

◆ MACLayer()

EMANE::MACLayer::MACLayer ( NEMId  id,
NEMLayer pImplementor,
PlatformServiceProvider pPlatformService 
)

Definition at line 38 of file libemane/maclayer.cc.

◆ ~MACLayer()

EMANE::MACLayer::~MACLayer ( )

Definition at line 46 of file libemane/maclayer.cc.

Member Function Documentation

◆ addFileDescriptor()

template<typename Function >
void EMANE::FileDescriptorServiceProvider::addFileDescriptor ( int  iFd,
DescriptorType  type,
Function  fn 
)
inherited

Adds a file descriptor for processing

Parameters
iFdFile descriptor
typeType of descriptor processing
fnA callable object

Definition at line 34 of file filedescriptorserviceprovider.inl.

◆ configure()

void EMANE::MACLayer::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 55 of file libemane/maclayer.cc.

◆ destroy()

void EMANE::MACLayer::destroy ( )
throw (
)
overridevirtual

Destroy the component.

Implements EMANE::Component.

Definition at line 81 of file libemane/maclayer.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::MACLayer::initialize ( Registrar registrar)
overridevirtual

Initialize the component.

Exceptions
InitializeExceptionthrown when an error is encountered during initialization

Implements EMANE::Component.

Definition at line 48 of file libemane/maclayer.cc.

◆ postStart()

void EMANE::MACLayer::postStart ( )
overridevirtual

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

Reimplemented from EMANE::Component.

Definition at line 68 of file libemane/maclayer.cc.

◆ processConfiguration()

void EMANE::NEMQueuedLayer::processConfiguration ( const ConfigurationUpdate update)
overridevirtualinherited

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

Definition at line 192 of file nemqueuedlayer.cc.

◆ processDownstreamControl()

void EMANE::NEMQueuedLayer::processDownstreamControl ( const ControlMessages msgs)
overridevirtualinherited

Process downstream control message

Parameters
msgsReference to the ControlMessages

Implements EMANE::DownstreamTransport.

Definition at line 200 of file nemqueuedlayer.cc.

◆ processDownstreamPacket()

void EMANE::NEMQueuedLayer::processDownstreamPacket ( DownstreamPacket pkt,
const ControlMessages msgs 
)
overridevirtualinherited

Process downstream packet

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

Implements EMANE::DownstreamTransport.

Definition at line 208 of file nemqueuedlayer.cc.

◆ processEvent()

void EMANE::NEMQueuedLayer::processEvent ( const EventId eventId,
const Serialization serialization 
)
overridevirtualinherited

Process an event.

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

Reimplemented from EMANE::EventServiceUser.

Definition at line 236 of file nemqueuedlayer.cc.

◆ processTimedEvent()

void EMANE::NEMQueuedLayer::processTimedEvent ( TimerEventId  eventId,
const TimePoint expireTime,
const TimePoint scheduleTime,
const TimePoint fireTime,
const void *  arg 
)
overridevirtualinherited

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 247 of file nemqueuedlayer.cc.

◆ processTimer()

template<typename Function >
void EMANE::NEMQueuedLayer::processTimer ( Function  fn,
const TimePoint expireTime,
const TimePoint scheduleTime,
const TimePoint fireTime 
)
inherited

Definition at line 34 of file nemqueuedlayer.inl.

◆ processUpstreamControl()

void EMANE::NEMQueuedLayer::processUpstreamControl ( const ControlMessages msgs)
overridevirtualinherited

Process upstream control message

Parameters
msgsreference to the ControlMessages

Implements EMANE::UpstreamTransport.

Definition at line 228 of file nemqueuedlayer.cc.

◆ processUpstreamPacket()

void EMANE::NEMQueuedLayer::processUpstreamPacket ( UpstreamPacket pkt,
const ControlMessages msgs 
)
overridevirtualinherited

Process upstream packet

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

Implements EMANE::UpstreamTransport.

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

void EMANE::MACLayer::setDownstreamTransport ( DownstreamTransport pDownstreamTransport)
overridevirtual

Set the downstream transport.

Parameters
pDownstreamTransportPointer to the downstream transport of this upstream transport.
Note
: This method is for internal framework use only.

Reimplemented from EMANE::UpstreamTransport.

Definition at line 119 of file libemane/maclayer.cc.

◆ setUpstreamTransport()

void EMANE::MACLayer::setUpstreamTransport ( UpstreamTransport pUpstreamTransport)
overridevirtual

Set the upstream transport.

Parameters
pUpstreamTransportPointer to the upstream transport of this downstream transport.

Reimplemented from EMANE::DownstreamTransport.

Definition at line 114 of file libemane/maclayer.cc.

◆ start()

void EMANE::MACLayer::start ( )
overridevirtual

Start the component.

Exceptions
StartExceptionthrown when an error is encountered during start.

Implements EMANE::Component.

Definition at line 60 of file libemane/maclayer.cc.

◆ stop()

void EMANE::MACLayer::stop ( )
overridevirtual

Stop the component.

Exceptions
StopExceptionthrown when an error is encountered during stop

Implements EMANE::Component.

Definition at line 73 of file libemane/maclayer.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.


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