robot/include/asio2/mqtt/mqtts_client.hpp

/*
 * Copyright (c) 2017-2023 zhllxt
 *
 * author   : zhllxt
 * email    : 37792738@qq.com
 * 
 * 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(ASIO2_ENABLE_SSL) || defined(ASIO2_USE_SSL)

#ifndef __ASIO2_MQTTS_CLIENT_HPP__
#define __ASIO2_MQTTS_CLIENT_HPP__

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
#pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include <asio2/base/detail/push_options.hpp>

#include <asio2/mqtt/mqtt_client.hpp>
#include <asio2/tcp/impl/ssl_stream_cp.hpp>
#include <asio2/tcp/impl/ssl_context_cp.hpp>

namespace asio2::detail
{
	ASIO2_CLASS_FORWARD_DECLARE_BASE;
	ASIO2_CLASS_FORWARD_DECLARE_TCP_BASE;
	ASIO2_CLASS_FORWARD_DECLARE_TCP_CLIENT;

	template<class derived_t, class args_t = template_args_mqtt_client>
	class mqtts_client_impl_t
		: public ssl_context_cp    <derived_t, args_t>
		, public mqtt_client_impl_t<derived_t, args_t>
		, public ssl_stream_cp     <derived_t, args_t>
	{
		ASIO2_CLASS_FRIEND_DECLARE_BASE;
		ASIO2_CLASS_FRIEND_DECLARE_TCP_BASE;
		ASIO2_CLASS_FRIEND_DECLARE_TCP_CLIENT;

	public:
		using super = mqtt_client_impl_t <derived_t, args_t>;
		using self  = mqtts_client_impl_t<derived_t, args_t>;

		using args_type   = args_t;
		using buffer_type = typename args_t::buffer_t;

		using ssl_context_comp = ssl_context_cp<derived_t, args_t>;
		using ssl_stream_comp  = ssl_stream_cp <derived_t, args_t>;

		using super::send;
		using super::async_send;

	public:
		/**
		 * @brief constructor
		 */
		template<class... Args>
		explicit mqtts_client_impl_t(
			asio::ssl::context::method method,
			Args&&... args
		)
			: ssl_context_comp(method)
			, super(std::forward<Args>(args)...)
			, ssl_stream_comp(*this, asio::ssl::stream_base::client)
		{
		}

		/**
		 * @brief constructor
		 */
		template<class... Args>
		explicit mqtts_client_impl_t(Args&&... args)
			: ssl_context_comp(ASIO2_DEFAULT_SSL_METHOD)
			, super(std::forward<Args>(args)...)
			, ssl_stream_comp(*this, asio::ssl::stream_base::client)
		{
		}

		/**
		 * @brief constructor
		 */
		explicit mqtts_client_impl_t()
			: ssl_context_comp(ASIO2_DEFAULT_SSL_METHOD)
			, super()
			, ssl_stream_comp(*this, asio::ssl::stream_base::client)
		{
		}

		/**
		 * @brief destructor
		 */
		~mqtts_client_impl_t()
		{
			this->stop();
		}

		/**
		 * @brief destroy the content of all member variables, this is used for solve the memory leaks.
		 * After this function is called, this class object cannot be used again.
		 */
		inline void destroy()
		{
			derived_t& derive = this->derived();

			derive.ssl_stream_.reset();

			super::destroy();
		}

		/**
		 * @brief get the stream object reference
		 * 
		 */
		inline typename ssl_stream_comp::ssl_stream_type& stream() noexcept
		{
			return this->derived().ssl_stream();
		}

		/**
		 * @brief get the stream object reference
		 * 
		 */
		inline typename ssl_stream_comp::ssl_stream_type const& stream() const noexcept
		{
			return this->derived().ssl_stream();
		}

	public:
		/**
		 * @brief bind ssl handshake listener
		 * @param fun - a user defined callback function.
		 * @param obj - a pointer or reference to a class object, this parameter can be none.
		 * if fun is nonmember function, the obj param must be none, otherwise the obj must be the
		 * the class object's pointer or reference.
		 * Function signature : void()
		 */
		template<class F, class ...C>
		inline derived_t & bind_handshake(F&& fun, C&&... obj)
		{
			this->listener_.bind(event_type::handshake,
				observer_t<>(std::forward<F>(fun), std::forward<C>(obj)...));
			return (this->derived());
		}

	protected:
		template<typename C>
		inline void _do_init(std::shared_ptr<ecs_t<C>>& ecs)
		{
			super::_do_init(ecs);

			this->derived()._ssl_init(ecs, this->derived().socket(), *this);
		}

		template<typename DeferEvent>
		inline void _post_shutdown(const error_code& ec, std::shared_ptr<derived_t> this_ptr, DeferEvent chain)
		{
			ASIO2_LOG_DEBUG("mqtts_client::_post_shutdown: {} {}", ec.value(), ec.message());

			this->derived()._ssl_stop(this_ptr, defer_event
			{
				[this, ec, this_ptr, e = chain.move_event()] (event_queue_guard<derived_t> g) mutable
				{
					super::_post_shutdown(ec, std::move(this_ptr), defer_event(std::move(e), std::move(g)));
				}, chain.move_guard()
			});
		}

		template<typename C, typename DeferEvent>
		inline void _handle_connect(
			const error_code& ec,
			std::shared_ptr<derived_t> this_ptr, std::shared_ptr<ecs_t<C>> ecs, DeferEvent chain)
		{
			set_last_error(ec);

			derived_t& derive = this->derived();

			if (ec)
			{
				return derive._done_connect(ec, std::move(this_ptr), std::move(ecs), std::move(chain));
			}

			derive._ssl_start(this_ptr, ecs, derive.socket(), *this);

			derive._post_handshake(std::move(this_ptr), std::move(ecs), std::move(chain));
		}

		template<typename C, typename DeferEvent>
		inline void _handle_handshake(
			const error_code& ec,
			std::shared_ptr<derived_t> this_ptr, std::shared_ptr<ecs_t<C>> ecs, DeferEvent chain)
		{
			set_last_error(ec);

			derived_t& derive = this->derived();

			derive._fire_handshake(this_ptr);

			if (ec)
			{
				return derive._done_connect(ec, std::move(this_ptr), std::move(ecs), std::move(chain));
			}

			super::_handle_connect(ec, std::move(this_ptr), std::move(ecs), std::move(chain));
		}

		inline void _fire_handshake(std::shared_ptr<derived_t>& this_ptr)
		{
			// the _fire_handshake must be executed in the thread 0.
			ASIO2_ASSERT(this->derived().io_->running_in_this_thread());

			detail::ignore_unused(this_ptr);

			this->listener_.notify(event_type::handshake);
		}
	};
}

namespace asio2
{
	using mqtts_client_args = detail::template_args_mqtt_client;

	template<class derived_t, class args_t>
	using mqtts_client_impl_t = detail::mqtts_client_impl_t<derived_t, args_t>;

	/**
	 * @brief ssl mqtt client
	 * @throws constructor maybe throw exception "Too many open files" (exception code : 24)
	 * asio::error::no_descriptors - Too many open files
	 */
	template<class derived_t>
	class mqtts_client_t : public detail::mqtts_client_impl_t<derived_t, detail::template_args_mqtt_client>
	{
	public:
		using detail::mqtts_client_impl_t<derived_t, detail::template_args_mqtt_client>::mqtts_client_impl_t;
	};

	/**
	 * @brief ssl mqtt client
	 * @throws constructor maybe throw exception "Too many open files" (exception code : 24)
	 * asio::error::no_descriptors - Too many open files
	 */
	class mqtts_client : public mqtts_client_t<mqtts_client>
	{
	public:
		using mqtts_client_t<mqtts_client>::mqtts_client_t;
	};
}

#if defined(ASIO2_INCLUDE_RATE_LIMIT)
#include <asio2/tcp/tcp_stream.hpp>
namespace asio2
{
	struct mqtts_rate_client_args : public mqtts_client_args
	{
		using socket_t = asio2::tcp_stream<asio2::simple_rate_policy>;
	};

	template<class derived_t>
	class mqtts_rate_client_t : public asio2::mqtts_client_impl_t<derived_t, mqtts_rate_client_args>
	{
	public:
		using asio2::mqtts_client_impl_t<derived_t, mqtts_rate_client_args>::mqtts_client_impl_t;
	};

	class mqtts_rate_client : public asio2::mqtts_rate_client_t<mqtts_rate_client>
	{
	public:
		using asio2::mqtts_rate_client_t<mqtts_rate_client>::mqtts_rate_client_t;
	};
}
#endif

#include <asio2/base/detail/pop_options.hpp>


#endif // !__ASIO2_MQTTS_CLIENT_HPP__

#endif