websocket_response.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/clients/http/websocket_response.hpp
/// @brief @copybrief clients::http::WebSocketResponse
 
#include <string>
 
#include <userver/clients/http/response.hpp>
#include <userver/fs/blocking/file_descriptor.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace websocket {
class WebSocketConnection;
struct Config;
}  // namespace websocket
 
namespace clients::http {
 
/// @brief HTTP response for WebSocket upgrade.
///
/// Call @ref clients::http::Request::PerformWebSocketHandshake()
/// to get one. After successful WebSocket handshake, you can use
/// MakeWebSocketConnection() to establish a WebSocket connection.
///
/// @snippet samples/websocket_client/main.cpp WebSocket client sample - handler
class WebSocketResponse final {
public:
    /// @cond
    WebSocketResponse(
        std::shared_ptr<Response> handshake_response,
        fs::blocking::FileDescriptor&& socket,
        std::string socket_preamble = {}
    );
    /// @endcond
 
    WebSocketResponse() = default;
    WebSocketResponse(WebSocketResponse&&) = default;
    WebSocketResponse(const WebSocketResponse&) = delete;
    WebSocketResponse& operator=(WebSocketResponse&&) = default;
    WebSocketResponse& operator=(const WebSocketResponse&) = delete;
 
    /// @brief Get the HTTP handshake response
    std::shared_ptr<Response> GetHandshakeResponse() { return handshake_response_; }
 
    /// @brief Check if WebSocket protocol upgrade was successful
    /// @returns true if handshake completed with status 101 Switching Protocols
    bool IsProtocolUpgraded() const;
 
    /// @brief Create a WebSocket connection from this response
    std::shared_ptr<websocket::WebSocketConnection> MakeWebSocketConnection();
 
    /// @brief Create a WebSocket connection from this response with custom websocket config
    std::shared_ptr<websocket::WebSocketConnection> MakeWebSocketConnectionWithConfig(const websocket::Config& config);
 
private:
    std::shared_ptr<Response> handshake_response_;
    fs::blocking::FileDescriptor socket_;
    /// Raw WebSocket frames drained from libcurl CONNECT_ONLY buffers.
    std::string socket_preamble_;
};
 
/// @cond
namespace impl {
 
/// Function pointer for curl::easy::enable_socket_extraction (curl thread, before remove).
std::string DrainCurlWebSocketPreamble(void* native_easy);
 
}  // namespace impl
/// @endcond
 
}  // namespace clients::http
 
USERVER_NAMESPACE_END