inspect_requests.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/server/handlers/inspect_requests.hpp
/// @brief @copybrief server::handlers::InspectRequests
 
#include <userver/server/handlers/http_handler_json_base.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace server {
 
class RequestsView;
 
namespace handlers {
 
/// @ingroup userver_components userver_http_handlers
///
/// @brief Handler that returns information about all in-flight requests.
///
/// The component has no service configuration except the
/// @ref userver_http_handlers "common handler options".
///
/// ## Static configuration example:
///
/// @snippet components/common_server_component_list_test.cpp  Sample handler inspect requests component config
///
/// ## Scheme
/// Provide an optional query parameter `body` to get the bodies of all the
/// in-flight requests.
class InspectRequests final : public HttpHandlerJsonBase {
public:
    InspectRequests(const components::ComponentConfig& config, const components::ComponentContext& component_context);
 
    /// @ingroup userver_component_names
    /// @brief The default name of server::handlers::InspectRequests
    static constexpr std::string_view kName = "handler-inspect-requests";
 
    formats::json::Value HandleRequestJsonThrow(
        const http::HttpRequest& request,
        const formats::json::Value& request_json,
        request::RequestContext& context
    ) const override;
 
    static yaml_config::Schema GetStaticConfigSchema();
 
private:
    RequestsView& view_;
};
 
}  // namespace handlers
}  // namespace server
 
template <>
constexpr inline bool components::kHasValidate<server::handlers::InspectRequests> = true;
 
USERVER_NAMESPACE_END