websocket_client.hpp

Go to the documentation of this file.

#pragma once
 
#include <roar/detail/promise_compat.hpp>
#include <roar/detail/pimpl_special_functions.hpp>
#include <roar/detail/shared_from_base.hpp>
#include <roar/websocket/websocket_base.hpp>
 
#include <boost/asio/any_io_executor.hpp>
#include <boost/asio/ssl/context.hpp>
#include <boost/beast/http/field.hpp>
#include <promise-cpp/promise.hpp>
 
#include <memory>
#include <optional>
#include <chrono>
#include <unordered_map>
 
namespace Roar
{
    class WebsocketClient : public Detail::SharedFromBase<WebsocketBase, WebsocketClient>
    {
      public:
        constexpr static std::chrono::seconds defaultTimeout{10};
 
        struct ConstructionArguments
        {
            boost::asio::any_io_executor executor;
 
            std::optional<boost::asio::ssl::context> sslContext;
        };
 
        WebsocketClient(ConstructionArguments&& args);
        ~WebsocketClient();
        WebsocketClient(WebsocketClient&&) = delete;
        WebsocketClient& operator=(WebsocketClient&&) = delete;
        WebsocketClient(WebsocketClient const&) = delete;
        WebsocketClient& operator=(WebsocketClient const&) = delete;
 
        struct ConnectParameters
        {
            std::string const& host;
 
            std::string const& port;
 
            std::string path = "/";
 
            std::chrono::seconds timeout = defaultTimeout;
 
            // Additional Websocket handshake headers.
            std::unordered_map<boost::beast::http::field, std::string> headers = {};
        };
        Detail::PromiseTypeBind<Detail::PromiseTypeBindThen<>, Detail::PromiseTypeBindFail<Error>>
        connect(ConnectParameters&& connectParameters);
 
      private:
        struct Implementation;
        std::unique_ptr<Implementation> impl_;
    };
}