wsf::comm::Message::Identifier Class Reference

#include <WsfCommMessage.hpp>

Public Member Functions
	Identifier ()=default
	Identifier (const Message &aMessage)
	Identifier (const WsfMessage &aMessage)
virtual	~Identifier ()=default
void	SetSerialNumber (unsigned int aSerialNumber)
void	SetSource (const Address &aAddress)
void	SetDestination (const Address &aAddress)
unsigned int	GetSerialNumber () const
const Address &	GetSource () const
const Address &	GetDestination () const
bool	operator== (const Identifier &aRhs) const
bool	operator!= (const Identifier &aRhs) const

Detailed Description

The Identifier class provides an object that can be constructed via messages and used as a unique handle for specifying a message without requiring the use of an entire message object. Serial numbers are not solely sufficient to identify a message in core due to widespread variances in how they have generated. Equivalent messages are determined based on a combination of the serial number, source, and destination.

Constructor & Destructor Documentation

Identifier() [1/3]

wsf::comm::Message::Identifier::Identifier ( )

default

References Identifier(), and wsf::comm::Message::Message().

Referenced by Identifier(), operator!=(), and operator==().

Identifier() [2/3]

wsf::comm::Message::Identifier::Identifier

(

const Message &

aMessage

)

References wsf::comm::Message::GetTraceRoute(), wsf::comm::Message::Message(), and wsf::comm::Message::SourceMessage().

Identifier() [3/3]

wsf::comm::Message::Identifier::Identifier

(

const WsfMessage &

aMessage

)

References GetSerialNumber().

~Identifier()

virtual wsf::comm::Message::Identifier::~Identifier ( )

virtualdefault

Member Function Documentation

GetDestination()

const Address & wsf::comm::Message::Identifier::GetDestination ( ) const

inline

Referenced by std::hash< wsf::comm::Message::Identifier >::operator()().

GetSerialNumber()

unsigned int wsf::comm::Message::Identifier::GetSerialNumber ( ) const

inline

Referenced by wsf::comm::medium::Guided::EndPropagation(), wsf::comm::medium::Unguided::EndPropagation(), Identifier(), and std::hash< wsf::comm::Message::Identifier >::operator()().

GetSource()

const Address & wsf::comm::Message::Identifier::GetSource ( ) const

inline

Referenced by wsf::comm::medium::Unguided::EndPropagation(), and std::hash< wsf::comm::Message::Identifier >::operator()().

operator!=()

bool wsf::comm::Message::Identifier::operator!=

(

const Identifier &

aRhs

)

const

References Identifier().

operator==()

bool wsf::comm::Message::Identifier::operator==

(

const Identifier &

aRhs

)

const

References Identifier().

SetDestination()

void wsf::comm::Message::Identifier::SetDestination ( const Address & aAddress )

inline

Referenced by wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD().

SetSerialNumber()

void wsf::comm::Message::Identifier::SetSerialNumber ( unsigned int aSerialNumber )

inline

Referenced by wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD().

SetSource()

void wsf::comm::Message::Identifier::SetSource ( const Address & aAddress )

inline

Referenced by wsf::comm::medium::UT_DEFINE_SCRIPT_METHOD().

---

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

• WsfCommMessage.hpp
• WsfCommMessage.cpp