v5_puback.hpp

// Copyright Takatoshi Kondo 2022
//
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
 
#if !defined(ASYNC_MQTT_PACKET_V5_PUBACK_HPP)
#define ASYNC_MQTT_PACKET_V5_PUBACK_HPP
 
#include <async_mqtt/buffer_to_packet_variant.hpp>
#include <async_mqtt/error.hpp>
 
#include <async_mqtt/packet/control_packet_type.hpp>
#include <async_mqtt/packet/packet_id_type.hpp>
#include <async_mqtt/packet/property_variant.hpp>
 
#include <async_mqtt/util/buffer.hpp>
#include <async_mqtt/util/static_vector.hpp>
 
namespace async_mqtt::v5 {
 
namespace as = boost::asio;
 
template <std::size_t PacketIdBytes>
class basic_puback_packet {
public:
 
    explicit basic_puback_packet(
        typename basic_packet_id_type<PacketIdBytes>::type packet_id,
        puback_reason_code reason_code,
        properties props
    );
 
    explicit basic_puback_packet(
        typename basic_packet_id_type<PacketIdBytes>::type packet_id
    );
 
    explicit basic_puback_packet(
        typename basic_packet_id_type<PacketIdBytes>::type packet_id,
        puback_reason_code reason_code
    );
 
    static constexpr control_packet_type type() {
        return control_packet_type::puback;
    }
 
    std::vector<as::const_buffer> const_buffer_sequence() const;
 
    std::size_t size() const;
 
    std::size_t num_of_const_buffer_sequence() const;
 
    typename basic_packet_id_type<PacketIdBytes>::type packet_id() const;
 
    puback_reason_code code() const;
 
    properties const& props() const;
 
    friend
    std::ostream& operator<<(std::ostream& o, basic_puback_packet<PacketIdBytes> const& v) {
        o <<
            "v5::puback{" <<
            "pid:" << v.packet_id();
        if (v.reason_code_) {
            o << ",rc:" << *v.reason_code_;
        }
        if (!v.props().empty()) {
            o << ",ps:" << v.props();
        };
        o << "}";
        return o;
    }
 
private:
 
    template <std::size_t PacketIdBytesArg>
    friend basic_packet_variant<PacketIdBytesArg>
    async_mqtt::buffer_to_basic_packet_variant(buffer buf, protocol_version ver, error_code& ec);
 
#if defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
    friend struct ::ut_packet::v5_puback;
    friend struct ::ut_packet::v5_puback_pid4;
    friend struct ::ut_packet::v5_puback_pid_only;
    friend struct ::ut_packet::v5_puback_pid_rc;
    friend struct ::ut_packet::v5_puback_prop_len_last;
    friend struct ::ut_packet::v5_puback_error;
#endif // defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
 
    // private constructor for internal use
    explicit basic_puback_packet(
        typename basic_packet_id_type<PacketIdBytes>::type packet_id,
        std::optional<puback_reason_code> reason_code,
        properties props
    );
 
    explicit basic_puback_packet(buffer buf, error_code& ec);
 
private:
    std::uint8_t fixed_header_;
    std::size_t remaining_length_;
    static_vector<char, 4> remaining_length_buf_;
    static_vector<char, PacketIdBytes> packet_id_;
 
    std::optional<puback_reason_code> reason_code_;
 
    std::size_t property_length_ = 0;
    static_vector<char, 4> property_length_buf_;
    properties props_;
};
 
template <std::size_t PacketIdBytes>
bool operator<(basic_puback_packet<PacketIdBytes> const& lhs, basic_puback_packet<PacketIdBytes> const& rhs);
 
template <std::size_t PacketIdBytes>
bool operator==(basic_puback_packet<PacketIdBytes> const& lhs, basic_puback_packet<PacketIdBytes> const& rhs);
 
using puback_packet = basic_puback_packet<2>;
 
} // namespace async_mqtt::v5
 
#if !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
#include <async_mqtt/packet/impl/v5_puback.ipp>
#endif // !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
 
#endif // ASYNC_MQTT_PACKET_V5_PUBACK_HPP