A Serialized Control Message is used to encapsulate Serializable control messages as they traverse process boundaries via a network connection. More...

#include <serializedcontrolmessage.h>

Inheritance diagram for EMANE::Controls::SerializedControlMessage:

Public Types
enum	{ IDENTIFIER = EMANE_CONTROL_MEASSGE_SERIALIZED }

Public Member Functions
SerializedControlMessage *	clone () const override

	~SerializedControlMessage ()

ControlMessageId	getSerializedId () const

std::string	getSerialization () const

ControlMessageId	getId () const

virtual Serialization	serialize () const

Static Public Member Functions
static SerializedControlMessage *	create (ControlMessageId id, const void *pData, size_t length)

Detailed Description

A Serialized Control Message is used to encapsulate Serializable control messages as they traverse process boundaries via a network connection.

Note: Instances are immutable

Encapulated control messages must be restored before use:

        case Controls::SerializedControlMessage::IDENTIFIER:
          {
            const auto pSerializedControlMessage =
              static_cast<const Controls::SerializedControlMessage *>(pMessage);
            switch(pSerializedControlMessage->getSerializedId())
              {
              case Controls::FlowControlControlMessage::IDENTIFIER:
                {
                  std::unique_ptr<Controls::FlowControlControlMessage>
                    pFlowControlControlMessage{
                    Controls::FlowControlControlMessage::create(pSerializedControlMessage->getSerialization())};
                  if(bFlowControlEnable_)
                    {
                      flowControlManager_.processFlowControlMessage(pFlowControlControlMessage.get());
                    }
                  else
                    {
                      LOGGER_STANDARD_LOGGING(pPlatformService_->logService(),
                                              ERROR_LEVEL,
                                              "MACI %03hu %s::%s received a flow control token request but"
                                              " flow control is not enabled",
                                              id_,
                                              pzLayerName,
                                              __func__);
                    }
                }
                break;
              }
          }

Definition at line 57 of file serializedcontrolmessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
IDENTIFIER

Definition at line 109 of file serializedcontrolmessage.h.

Constructor & Destructor Documentation

◆ ~SerializedControlMessage()

EMANE::Controls::SerializedControlMessage::~SerializedControlMessage ( )

Destroys an instance

Definition at line 74 of file serializedcontrolmessage.cc.

Member Function Documentation

◆ clone()

EMANE::Controls::SerializedControlMessage * EMANE::Controls::SerializedControlMessage::clone ( ) const

overridevirtual

Clones the control message on the heap

Returns: cloned message

Note: Caller assumes ownership of the clone

Implements EMANE::Cloneable< ControlMessage >.

Definition at line 98 of file serializedcontrolmessage.cc.

◆ create()

EMANE::Controls::SerializedControlMessage * EMANE::Controls::SerializedControlMessage::create	(	ControlMessageId	id,
		const void *	pData,
		size_t	length
	)

static

Creates a SerializedControlMessage instance on the heap

Parameters

id	Control message id of the message being serialized
pData	Pointer to the serialized data
length	Serialized data length

Note: Once a control message is passed to another NEM layer using EMANE::UpstreamTransport::processUpstreamPacket(), EMANE::UpstreamTransport::processUpstreamControl(), EMANE::DownstreamTransport::processDownstreamPacket() or EMANE::DownstreamTransport::processDownstreamControl() object ownership is transferred to the emulator infrastructure along with deallocation responsibility. It is not valid to use a control message instance after it has been passed to another layer.

Definition at line 90 of file serializedcontrolmessage.cc.

◆ getId()

ControlMessageId EMANE::ControlMessage::getId ( ) const

inlineinherited

Gets the control message id

Returns: control messase id

Definition at line 64 of file controlmessage.h.

◆ getSerialization()

std::string EMANE::Controls::SerializedControlMessage::getSerialization ( ) const

Gets the message serialization

Returns: serialization

Definition at line 83 of file serializedcontrolmessage.cc.

◆ getSerializedId()

EMANE::ControlMessageId EMANE::Controls::SerializedControlMessage::getSerializedId ( ) const

Gets the control message id of the serialized message

Returns: control message id

Definition at line 77 of file serializedcontrolmessage.cc.

◆ serialize()

virtual Serialization EMANE::Serializable::serialize ( ) const

inlinevirtualinherited

Gets the serialized form of the object

Returns: serialization

Exceptions

SerializationException

Note: Most objects use Google Protocol Buffers to perform serialization. This is why the Serialization type is a std::string. The serialized data is binary, non-printable data. The std::string just provides a simple API.; https://developers.google.com/protocol-buffers/

Reimplemented in EMANE::Controls::R2RISelfMetricControlMessage, EMANE::Controls::R2RINeighborMetricControlMessage, EMANE::Controls::OTATransmitterControlMessage, EMANE::Controls::R2RIQueueMetricControlMessage, EMANE::Controls::FlowControlControlMessage, EMANE::Events::CommEffectEvent, EMANE::Events::AntennaProfileEvent, EMANE::Events::FadingSelectionEvent, EMANE::Events::LocationEvent, EMANE::Events::PathlossEvent, EMANE::Models::IEEE80211ABG::MACHeaderMessage, EMANE::Models::TDMA::BaseModelMessage, EMANE::Models::TimingAnalysis::ShimHeaderMessage, EMANE::Messages::LoggerRecordMessage, EMANE::Models::RFPipe::MACHeaderMessage, EMANE::Models::IEEE80211ABG::OneHopNeighborsEvent, and EMANE::Models::CommEffect::ShimHeader.

Definition at line 69 of file serializable.h.

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

Public Types

Public Member Functions

Static Public Member Functions