wsf::comm::SessionLayer Class Reference

#include <WsfCommSessionLayer.hpp>

Inheritance diagram for wsf::comm::SessionLayer:

Collaboration diagram for wsf::comm::SessionLayer:

Public Member Functions
	SessionLayer ()
	~SessionLayer () override=default
Public Member Functions inherited from wsf::comm::LayerImp
virtual	~LayerImp ()=default
void	SetUpperLayer (Layer *aLayerPtr)
Layer *	GetUpperLayer () const
void	SetLowerLayer (Layer *aLayerPtr)
Layer *	GetLowerLayer () const
bool	DebugEnabled () const
	Determine if debugging is enabled.
void	SetDebugEnabled (bool aDebugEnabled)
virtual bool	Initialize2 (double aSimTime)
Comm *	Parent () const
void	SetParent (Comm *aParentCommPtr)
void	SetIndex (size_t aIndex)
size_t	GetIndex () const

Common infrastructure methods.
LayerImp *	Clone () const override
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override

Send/Receive methods
bool	Receive (double aSimTime, Comm *aXmtrPtr, Message &aMessage, bool &aNotifyNextLayer) override
bool	Send (double aSimTime, size_t aLayerIndex, Message &aMessage, bool &aNotifyNextLayer) override

Comm event methods.
bool	ProcessLayerMessage (double aSimTime, layer::Message aLayerMessage, Message *aCommMessagePtr) override
	Process a layer event.
	SessionLayer (const SessionLayer &aSrc)

Constructor & Destructor Documentation

SessionLayer() [1/2]

wsf::comm::SessionLayer::SessionLayer ( )

inline

Referenced by Clone(), and SessionLayer().

~SessionLayer()

wsf::comm::SessionLayer::~SessionLayer ( )

overridedefault

References Clone().

SessionLayer() [2/2]

wsf::comm::SessionLayer::SessionLayer ( const SessionLayer & aSrc )

inlineprotected

References SessionLayer().

Member Function Documentation

Clone()

LayerImp * wsf::comm::SessionLayer::Clone ( ) const

overridevirtual

Implements wsf::comm::LayerImp.

References SessionLayer().

Referenced by ~SessionLayer().

Initialize()

bool wsf::comm::SessionLayer::Initialize ( double aSimTime )

inlineoverridevirtual

Implements wsf::comm::LayerImp.

ProcessInput()

bool wsf::comm::SessionLayer::ProcessInput ( UtInput & aInput )

inlineoverridevirtual

Implements wsf::comm::LayerImp.

ProcessLayerMessage()

bool wsf::comm::SessionLayer::ProcessLayerMessage ( double aSimTime, layer::Message aLayerMessage, Message * aCommMessagePtr )

overridevirtual

Process a layer event.

Implements wsf::comm::LayerImp.

References wsf::comm::layer::cDOWN_ACK_RECEIVE(), wsf::comm::layer::cDOWN_ACK_SEND(), wsf::comm::layer::cDOWN_NACK_RECEIVE(), wsf::comm::layer::cDOWN_NACK_SEND(), wsf::comm::layer::cUP_ACK_RECEIVE(), wsf::comm::layer::cUP_ACK_SEND(), wsf::comm::layer::cUP_NACK_RECEIVE(), wsf::comm::layer::cUP_NACK_SEND(), wsf::comm::layer::Message::GetValue(), and success.

Receive()

bool wsf::comm::SessionLayer::Receive ( double aSimTime, Comm * aXmtrPtr, Message & aMessage, bool & aNotifyNextLayer )

overridevirtual

Receive the message in this layer.

Parameters

aSimTime	[input] The current simulation time.
aXmtrPtr	[input] The comm device that sent the message.
aMessage	[input] The communication message being received.
aNotifyNextLayer	[output] True if the next layer above this one should immediately process this message.

Returns

'true' if layer successfully processed the message.

Implements wsf::comm::LayerImp.

References wsf::comm::LayerImp::GetIndex(), wsf::comm::Comm::GetSortedProtocols(), wsf::comm::LayerImp::Parent(), and success.

Send()

bool wsf::comm::SessionLayer::Send ( double aSimTime, size_t aLayerIndex, Message & aMessage, bool & aNotifyNextLayer )

overridevirtual

Send the message to this layer.

Parameters

aSimTime	[input] The current simulation time.
aLayerIndex	[input] The index in the protocol stack for this layer.
aMessage	[input] The communication message being received.
aNotifyNextLayer	[output] True if the next layer below this one should immediately process this message.

Returns

'true' if layer successfully processed the message.

Implements wsf::comm::LayerImp.

References wsf::comm::LayerImp::GetIndex(), wsf::comm::Comm::GetSortedProtocols(), wsf::comm::LayerImp::Parent(), and success.

---

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

• WsfCommSessionLayer.hpp
• WsfCommSessionLayer.cpp