MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes > Class Template Reference

#include <message.hpp>

Public Member Functions
template<typename ConstBufferSequence , typename std::enable_if< as::is_const_buffer_sequence< ConstBufferSequence >::value, std::nullptr_t >::type = nullptr>
	basic_publish_message (typename packet_id_type< PacketIdBytes >::type packet_id, as::const_buffer topic_name, ConstBufferSequence payloads, publish_options pubopts)
	basic_publish_message (buffer buf)
std::vector< as::const_buffer >	const_buffer_sequence () const
	Create const buffer sequence it is for boost asio APIs. More...
std::size_t	size () const
	Get whole size of sequence. More...
std::size_t	num_of_const_buffer_sequence () const
	Get number of element of const_buffer_sequence. More...
std::string	continuous_buffer () const
	Create one continuous buffer. All sequence of buffers are concatinated. It is useful to store to file/database. More...
packet_id_type< PacketIdBytes >::type	packet_id () const
	Get packet id. More...
constexpr publish_options	get_options () const
	Get publish_options. More...
constexpr qos	get_qos () const
	Get qos. More...
constexpr bool	is_retain () const
	Check retain flag. More...
constexpr bool	is_dup () const
	Check dup flag. More...
constexpr string_view	topic () const
	Get topic name. More...
std::vector< string_view >	payload () const
	Get payload. More...
buffer	payload_as_buffer () const
	Get payload as single buffer. More...
constexpr void	set_dup (bool dup)
	Set dup flag. More...

Constructor & Destructor Documentation

basic_publish_message() [1/2]

template<std::size_t PacketIdBytes>

template<typename ConstBufferSequence , typename std::enable_if< as::is_const_buffer_sequence< ConstBufferSequence >::value, std::nullptr_t >::type = nullptr>

MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::basic_publish_message ( typename packet_id_type< PacketIdBytes >::type  packet_id, as::const_buffer  topic_name, ConstBufferSequence  payloads, publish_options  pubopts  )

inline

basic_publish_message() [2/2]

template<std::size_t PacketIdBytes>

MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::basic_publish_message ( buffer  buf )

inline

Member Function Documentation

const_buffer_sequence()

template<std::size_t PacketIdBytes>

std::vector<as::const_buffer> MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::const_buffer_sequence ( ) const

inline

Create const buffer sequence it is for boost asio APIs.

Returns

const buffer sequence

continuous_buffer()

template<std::size_t PacketIdBytes>

std::string MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::continuous_buffer ( ) const

inline

Create one continuous buffer. All sequence of buffers are concatinated. It is useful to store to file/database.

Returns

continuous buffer

get_options()

template<std::size_t PacketIdBytes>

constexpr publish_options MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::get_options ( ) const

inlineconstexpr

Get publish_options.

Returns

publish_options.

get_qos()

template<std::size_t PacketIdBytes>

constexpr qos MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::get_qos ( ) const

inlineconstexpr

Get qos.

Returns

qos

is_dup()

template<std::size_t PacketIdBytes>

constexpr bool MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::is_dup ( ) const

inlineconstexpr

Check dup flag.

Returns

true if dup, otherwise return false.

is_retain()

template<std::size_t PacketIdBytes>

constexpr bool MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::is_retain ( ) const

inlineconstexpr

Check retain flag.

Returns

true if retain, otherwise return false.

num_of_const_buffer_sequence()

template<std::size_t PacketIdBytes>

std::size_t MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::num_of_const_buffer_sequence ( ) const

inline

Get number of element of const_buffer_sequence.

Returns

number of element of const_buffer_sequence

packet_id()

template<std::size_t PacketIdBytes>

packet_id_type<PacketIdBytes>::type MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::packet_id ( ) const

inline

Get packet id.

Returns

packet_id

payload()

template<std::size_t PacketIdBytes>

std::vector<string_view> MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::payload ( ) const

inline

Get payload.

Returns

payload

payload_as_buffer()

template<std::size_t PacketIdBytes>

buffer MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::payload_as_buffer ( ) const

inline

Get payload as single buffer.

Returns

payload

set_dup()

template<std::size_t PacketIdBytes>

constexpr void MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::set_dup ( bool  dup )

inlineconstexpr

Set dup flag.

Parameters

dup	flag value to set

size()

template<std::size_t PacketIdBytes>

std::size_t MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::size ( ) const

inline

Get whole size of sequence.

Returns

whole size

topic()

template<std::size_t PacketIdBytes>

constexpr string_view MQTT_NS::v3_1_1::basic_publish_message< PacketIdBytes >::topic ( ) const

inlineconstexpr

Get topic name.

Returns

topic name

---

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

• /home/kondo/work/mqtt_cpp/include/mqtt/message.hpp