EMANE  1.2.1
EMANE::EventAgent Class Referenceabstract

Base class for all event agents. More...

#include <eventagent.h>

Inheritance diagram for EMANE::EventAgent:
EMANE::Component EMANE::PlatformServiceUser EMANE::Buildable EMANE::EventServiceUser EMANE::TimerServiceUser EMANE::Agents::GPSDLocation::Agent

Public Member Functions

virtual ~EventAgent ()
 
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 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)
 

Protected Member Functions

 EventAgent (NEMId id, PlatformServiceProvider *pPlatformService)
 

Protected Attributes

NEMId id_
 
PlatformServiceProviderpPlatformService_
 

Detailed Description

Base class for all event agents.

Definition at line 52 of file eventagent.h.

Constructor & Destructor Documentation

◆ ~EventAgent()

virtual EMANE::EventAgent::~EventAgent ( )
inlinevirtual

Destroys an instance

Definition at line 60 of file eventagent.h.

◆ EventAgent()

EMANE::EventAgent::EventAgent ( NEMId  id,
PlatformServiceProvider pPlatformService 
)
inlineprotected

Definition at line 63 of file eventagent.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.

◆ initialize()

◆ postStart()

◆ 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.

◆ 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.

◆ start()

◆ stop()

Member Data Documentation

◆ id_

NEMId EMANE::EventAgent::id_
protected

Definition at line 68 of file eventagent.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 file: