Initial state for all NEMStatefulLayers. The only allowable transition is Component::initialize() More...

#include <nemlayerstateuninitialized.h>

Inheritance diagram for EMANE::NEMLayerStateUninitialized:

Public Member Functions
	~NEMLayerStateUninitialized ()

void	handleInitialize (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, Registrar &registrar)

virtual void	handleConfigure (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, const ConfigurationUpdate &update)

virtual void	handleStart (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer)

virtual void	handlePostStart (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer)

virtual void	handleStop (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer)

virtual void	handleDestroy (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer) throw ()

virtual void	processConfiguration (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, const ConfigurationUpdate &update)

virtual void	processDownstreamControl (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, const ControlMessages &msgs)

virtual void	processDownstreamPacket (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, DownstreamPacket &pkt, const ControlMessages &msgs)

virtual void	processUpstreamPacket (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, UpstreamPacket &pkt, const ControlMessages &msgs)

virtual void	processUpstreamControl (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, const ControlMessages &msgs)

virtual void	processEvent (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, const EventId &id, const Serialization &serialization)

virtual void	processTimedEvent (NEMStatefulLayer pStatefulLayer, NEMLayer pLayer, TimerEventId eventId, const TimePoint &expireTime, const TimePoint &scheduleTime, const TimePoint &fireTime, const void *arg)

std::string	getStateName () const

Static Public Member Functions
static NEMLayerStateUninitialized *	instance ()

static void	destroy ()

Protected Member Functions
	NEMLayerStateUninitialized ()

void	changeState (NEMStatefulLayer pStatefulLayer, NEMLayerState pState)

Protected Attributes
const char *	pzStateName_

Detailed Description

Initial state for all NEMStatefulLayers. The only allowable transition is Component::initialize()

Definition at line 49 of file nemlayerstateuninitialized.h.

Constructor & Destructor Documentation

◆ ~NEMLayerStateUninitialized()

EMANE::NEMLayerStateUninitialized::~NEMLayerStateUninitialized ( )

Definition at line 41 of file nemlayerstateuninitialized.cc.

◆ NEMLayerStateUninitialized()

EMANE::NEMLayerStateUninitialized::NEMLayerStateUninitialized ( )

protected

Definition at line 38 of file nemlayerstateuninitialized.cc.

Member Function Documentation

◆ changeState()

void EMANE::NEMLayerState::changeState	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayerState *	pState
	)

protectedinherited

Definition at line 192 of file nemlayerstate.cc.

◆ destroy()

static void EMANE::Utils::Singleton< NEMLayerStateUninitialized >::destroy ( )

inlinestaticinherited

Destroys the single instance of type T. Once destroyed it cannot be used or recreated. This is not a thread-safe method.

Definition at line 67 of file singleton.h.

◆ getStateName()

std::string EMANE::NEMLayerState::getStateName ( ) const

inherited

Get state name

Returns: state Name of current state

Definition at line 198 of file nemlayerstate.cc.

◆ handleConfigure()

void EMANE::NEMLayerState::handleConfigure	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		const ConfigurationUpdate &	update
	)

virtualinherited

Handle configuration

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
update	Configuration update

Exceptions

ConfigureException

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateConfigured, and EMANE::NEMLayerStateInitialized.

Definition at line 54 of file nemlayerstate.cc.

◆ handleDestroy()

void EMANE::NEMLayerState::handleDestroy	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer
	)
throw	(
	)

virtualinherited

Handle destroy

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateStopped.

Definition at line 95 of file nemlayerstate.cc.

◆ handleInitialize()

void EMANE::NEMLayerStateUninitialized::handleInitialize	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		Registrar &	registrar
	)

virtual

Handle initialize

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
registrar	Registrar reference

Exceptions

InitializeException

Note: A successful initialize will result in the transition to the NEMLayerStateInitialized state

Reimplemented from EMANE::NEMLayerState.

Definition at line 43 of file nemlayerstateuninitialized.cc.

◆ handlePostStart()

void EMANE::NEMLayerState::handlePostStart	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer
	)

virtualinherited

Handle post start

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 75 of file nemlayerstate.cc.

◆ handleStart()

void EMANE::NEMLayerState::handleStart	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer
	)

virtualinherited

Handle start

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer

Exceptions

StartException

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateConfigured.

Definition at line 65 of file nemlayerstate.cc.

◆ handleStop()

void EMANE::NEMLayerState::handleStop	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer
	)

virtualinherited

Handle stop

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer

Exceptions

StopException

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 85 of file nemlayerstate.cc.

◆ instance()

static NEMLayerStateUninitialized * EMANE::Utils::Singleton< NEMLayerStateUninitialized >::instance ( )

inlinestaticinherited

Provides thread-safe access to a single instance of type T. It does not provide thread-safety for T methods.

Returns: A pointer to T

Definition at line 56 of file singleton.h.

◆ processConfiguration()

void EMANE::NEMLayerState::processConfiguration	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		const ConfigurationUpdate &	update
	)

virtualinherited

Process configuration update

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
update	Reference to the configuration update

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 106 of file nemlayerstate.cc.

◆ processDownstreamControl()

void EMANE::NEMLayerState::processDownstreamControl	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		const ControlMessages &	msgs
	)

virtualinherited

Process downstream control

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
msgs	Reference to the Control message

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 117 of file nemlayerstate.cc.

◆ processDownstreamPacket()

void EMANE::NEMLayerState::processDownstreamPacket	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		DownstreamPacket &	pkt,
		const ControlMessages &	msgs
	)

virtualinherited

Process downstream packet

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
pkt	Reference to the Downstream packet
msgs	reference to the ControlMessage

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 128 of file nemlayerstate.cc.

◆ processEvent()

void EMANE::NEMLayerState::processEvent	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		const EventId &	id,
		const Serialization &	serialization
	)

virtualinherited

Process event

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
id	Event Id
serialization	Event object serialization

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 163 of file nemlayerstate.cc.

◆ processTimedEvent()

void EMANE::NEMLayerState::processTimedEvent	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		TimerEventId	eventId,
		const TimePoint &	expireTime,
		const TimePoint &	scheduleTime,
		const TimePoint &	fireTime,
		const void *	arg
	)

virtualinherited

Process timed event

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
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: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 176 of file nemlayerstate.cc.

◆ processUpstreamControl()

void EMANE::NEMLayerState::processUpstreamControl	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		const ControlMessages &	msgs
	)

virtualinherited

Process upstream control

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
msgs	Reference to the Control message

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 152 of file nemlayerstate.cc.

◆ processUpstreamPacket()

void EMANE::NEMLayerState::processUpstreamPacket	(	NEMStatefulLayer *	pStatefulLayer,
		NEMLayer *	pLayer,
		UpstreamPacket &	pkt,
		const ControlMessages &	msgs
	)

virtualinherited

Process downstream packet

Parameters

pStatefulLayer	Reference to the stateful layer
pLayer	Reference to the wrapped layer
pkt	Reference to the Upstream packet
msgs	reference to the ControlMessage

Note: Default implementation generates a log error

Reimplemented in EMANE::NEMLayerStateRunning.

Definition at line 140 of file nemlayerstate.cc.

Member Data Documentation

◆ pzStateName_

const char* EMANE::NEMLayerState::pzStateName_

protectedinherited

Definition at line 252 of file nemlayerstate.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~NEMLayerStateUninitialized()

◆ NEMLayerStateUninitialized()

Member Function Documentation

◆ changeState()

◆ destroy()

◆ getStateName()

◆ handleConfigure()

◆ handleDestroy()

◆ handleInitialize()

◆ handlePostStart()

◆ handleStart()

◆ handleStop()

◆ instance()

◆ processConfiguration()

◆ processDownstreamControl()

◆ processDownstreamPacket()

◆ processEvent()

◆ processTimedEvent()

◆ processUpstreamControl()

◆ processUpstreamPacket()

Member Data Documentation

◆ pzStateName_