wsf::comm::Message Class Reference

#include <WsfCommMessage.hpp>

Inheritance diagram for wsf::comm::Message:

Collaboration diagram for wsf::comm::Message:

Classes
class	Identifier

Public Member Functions
	Message (std::unique_ptr< WsfMessage > aMessagePtr)
WSF_DEPRECATED	Message (const WsfMessage &aMessage)
virtual	~Message ()
	Message (const Message &aSrc)
	Copy constructor (for Clone()).
	Message (Message &&)=default
Message &	operator= (const Message &aRhs)
Message &	operator= (Message &&)=default
const char *	GetScriptClassName () const override
virtual Message *	Clone () const
ut::CloneablePtr< WsfMessage > &	SourceMessage ()
const ut::CloneablePtr< WsfMessage > &	SourceMessage () const
virtual void	SetSourceMessage (std::unique_ptr< WsfMessage > aMessagePtr)
MessageHeader *	PopHeader ()
void	PushHeader (MessageHeader *aHeader)
MessageTrailer *	PopTrailer ()
void	PushTrailer (MessageTrailer *aTrailer)
std::vector< Address > &	GetTraceRoute ()
const std::vector< Address > &	GetTraceRoute () const
unsigned int &	GetTransportFeatures ()
	Return by reference accessor/mutator.
size_t	GetTTL () const
virtual void	SetTTL (size_t aTTL)
Result &	GetResult ()
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Additional Inherited Members
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed

Constructor & Destructor Documentation

Message() [1/4]

wsf::comm::Message::Message

(

std::unique_ptr< WsfMessage >

aMessagePtr

)

Referenced by Clone(), wsf::comm::Message::Identifier::Identifier(), wsf::comm::Message::Identifier::Identifier(), Message(), Message(), Message(), operator=(), and operator=().

Message() [2/4]

wsf::comm::Message::Message

(

const WsfMessage &

aMessage

)

References Message().

~Message()

wsf::comm::Message::~Message ( )

virtual

Message() [3/4]

wsf::comm::Message::Message

(

const Message &

aSrc

)

Copy constructor (for Clone()).

References for(), Message(), and WsfAuxDataEnabled::WsfAuxDataEnabled().

Message() [4/4]

wsf::comm::Message::Message ( Message && )

default

References Message(), and operator=().

Member Function Documentation

Clone()

Message * wsf::comm::Message::Clone ( ) const

virtual

References Message().

Referenced by wsf::comm::Event::ScheduleDeliverMessageEvent().

GetResult()

Result & wsf::comm::Message::GetResult ( )

inline

Referenced by wsf::comm::RadioXmtrRcvr::CanSendTo(), wsf::comm::medium::ModeUnguided::GetTransmissionTime(), wsf::comm::PhysicalLayerJTIDS::Receive(), wsf::comm::Comm::ReceiveActions(), WsfJTIDS_Terminal::ReceiveActions(), and wsf::comm::medium::Unguided::TransmitMessage().

GetScriptClassName()

const char * wsf::comm::Message::GetScriptClassName ( ) const

inlineoverride

GetTraceRoute() [1/2]

std::vector< Address > & wsf::comm::Message::GetTraceRoute ( )

inline

Referenced by wsf::comm::medium::Guided::EndTransmission(), wsf::comm::medium::Unguided::EndTransmission(), wsf::comm::router::ProtocolMulticast::ForwardMessage(), wsf::comm::Message::Identifier::Identifier(), wsf::comm::NetworkLayer::ProcessLayerMessage(), and wsf::comm::router::ProtocolOSPF::ReceiveHello().

GetTraceRoute() [2/2]

const std::vector< Address > & wsf::comm::Message::GetTraceRoute ( ) const

inline

GetTransportFeatures()

unsigned int & wsf::comm::Message::GetTransportFeatures ( )

inline

Return by reference accessor/mutator.

Referenced by wsf::comm::TransportLayer::Send().

GetTTL()

size_t wsf::comm::Message::GetTTL ( ) const

inline

operator=() [1/2]

Message & wsf::comm::Message::operator=

(

const Message &

aRhs

)

References Message(), WsfAuxDataEnabled::operator=(), PushHeader(), and PushTrailer().

Referenced by Message().

operator=() [2/2]

Message & wsf::comm::Message::operator= ( Message && )

default

References Message().

PopHeader()

MessageHeader * wsf::comm::Message::PopHeader

(

)

PopTrailer()

MessageTrailer * wsf::comm::Message::PopTrailer

(

)

PushHeader()

void wsf::comm::Message::PushHeader

(

MessageHeader *

aHeader

)

Referenced by operator=().

PushTrailer()

void wsf::comm::Message::PushTrailer

(

MessageTrailer *

aTrailer

)

Referenced by operator=().

SetSourceMessage()

void wsf::comm::Message::SetSourceMessage ( std::unique_ptr< WsfMessage > aMessagePtr )

virtual

SetTTL()

virtual void wsf::comm::Message::SetTTL ( size_t aTTL )

inlinevirtual

SourceMessage() [1/2]

ut::CloneablePtr< WsfMessage > & wsf::comm::Message::SourceMessage ( )

inline

Referenced by wsf::comm::DatalinkLayer::AddToQueue(), WsfJTIDS_SlotGroup::BeginTransmitEvent(), wsf::comm::router::ProtocolMulticast::ForwardMessage(), wsf::comm::ProtocolIGMP::GetMessageAddressFromAux(), wsf::comm::medium::ModeUnguided::GetTransmissionTime(), wsf::comm::Message::Identifier::Identifier(), wsf::comm::router::ProtocolOSPF::MyMessage(), wsf::comm::ProtocolIGMP::NetworkReceive(), wsf::comm::ProtocolIGMP::NetworkSend(), wsf::comm::ProtocolIGMP::PhysicalReceive(), wsf::comm::Queue::Pop(), wsf::comm::Comm::PrintDebugReception(), WsfJTIDS_Terminal::PrintDebugReception(), wsf::comm::NetworkLayer::ProcessLayerMessage(), wsf::comm::Queue::Push(), wsf::comm::NetworkLayer::Receive(), wsf::comm::router::ProtocolMulticast::Receive(), wsf::comm::router::ProtocolOSPF::Receive(), wsf::comm::router::rip::RIPv2::Receive(), wsf::xio::CommComponent::Receive(), wsf::comm::Comm::ReceiveActions(), WsfJTIDS_Terminal::ReceiveActions(), wsf::comm::router::ProtocolOSPF::ReceiveDR_GraphAdd(), wsf::comm::router::ProtocolOSPF::ReceiveDR_GraphDrop(), wsf::comm::router::ProtocolOSPF::ReceiveHello(), wsf::comm::router::ProtocolAdHoc::Routing(), wsf::comm::router::ProtocolLegacy::Routing(), wsf::comm::router::ProtocolMulticast::Routing(), wsf::comm::router::ProtocolOSPF::Routing(), wsf::comm::router::rip::RIPv2::Routing(), wsf::comm::Comm::Send(), wsf::comm::PhysicalLayer::Send(), wsf::comm::ProtocolStack::Send(), wsf::comm::router::ProtocolMulticast::Send(), wsf::comm::SlotGroupLayerJTIDS::Send(), wsf::comm::Comm::SendSetup(), WsfJTIDS_Terminal::SendSetup(), wsf::comm::Queue::Top(), wsf::comm::DatalinkLayer::TransmitComplete(), WsfJTIDS_SlotGroup::TransmitCompleteEvent(), WsfJTIDS_SlotGroup::TransmitEventsStopped(), wsf::comm::DatalinkLayer::TransmitFailed(), wsf::comm::medium::Guided::TransmitMessage(), and wsf::comm::medium::Unguided::TransmitMessage().

SourceMessage() [2/2]

const ut::CloneablePtr< WsfMessage > & wsf::comm::Message::SourceMessage ( ) const

inline

---

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

• WsfCommMessage.hpp
• WsfCommMessage.cpp