SObjectizer  5.5
Public Member Functions | Private Attributes | List of all members
so_5::enveloped_msg::payload_info_t Class Reference

An information about payload inside envelope. More...

#include <enveloped_msg.hpp>

Public Member Functions

 payload_info_t (message_ref_t message)
 Initializing constructor. More...
 
Getters
SO_5_NODISCARD message_ref_tmessage () const noexcept
 

Private Attributes

message_ref_t m_message
 Actual enveloped message. More...
 

Detailed Description

An information about payload inside envelope.

This class is necessary for incapsulation of information related to payload inside an envelope. In v.5.5.23 this class contains only reference to the payload message. But additional info can be added in some future versions.

Since
v.5.5.23

Constructor & Destructor Documentation

◆ payload_info_t()

so_5::enveloped_msg::payload_info_t::payload_info_t ( message_ref_t  message)
inline

Initializing constructor.

Member Function Documentation

◆ message()

SO_5_NODISCARD message_ref_t& so_5::enveloped_msg::payload_info_t::message ( ) const
inlinenoexcept

Member Data Documentation

◆ m_message

message_ref_t so_5::enveloped_msg::payload_info_t::m_message
mutableprivate

Actual enveloped message.

This member is mutable because we need to return non-const reference to message_ref_t from const method message().

Note
This pointer can be null if the enveloped message is a signal.

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