server.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/server/server.hpp
/// @brief @copybrief server::Server
 
#include <userver/formats/json/value.hpp>
 
#include <userver/components/component_context.hpp>
#include <userver/engine/deadline.hpp>
#include <userver/engine/task/task_processor_fwd.hpp>
#include <userver/server/congestion_control/limiter.hpp>
#include <userver/server/congestion_control/sensor.hpp>
#include <userver/server/handlers/fallback_handlers.hpp>
#include <userver/server/handlers/http_handler_base.hpp>
#include <userver/storages/secdist/component.hpp>
#include <userver/utils/resource_scopes.hpp>
#include <userver/utils/statistics/fwd.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace server {
 
namespace net {
struct StatsAggregation;
}
 
namespace http {
class HttpRequestHandler;
}
 
class RequestsView;
 
class ServerImpl;
struct ServerConfig;
 
/// @brief Main HTTP server instance
class Server final : public congestion_control::Limitee, public congestion_control::RequestsSource {
public:
    Server(
        ServerConfig config,
        const storages::secdist::SecdistConfig& secdist,
        const components::ComponentContext& component_context
    );
    ~Server() override;
 
    const ServerConfig& GetConfig() const;
 
    std::vector<std::string> GetCommonMiddlewares() const;
 
    void WriteMonitorData(utils::statistics::Writer& writer) const;
 
    void WriteTotalHandlerStatistics(utils::statistics::Writer& writer) const;
 
    net::StatsAggregation GetServerStats() const;
 
    void AddHandler(const handlers::HttpHandlerBase& handler, engine::TaskProcessor& task_processor);
 
    const http::HttpRequestHandler& GetHttpRequestHandler(bool is_monitor = false) const;
 
    void StartMonitorPort();
 
    void Start();
 
    void StopServing(engine::Deadline serving_shutdown_deadline);
 
    void Stop();
 
    RequestsView& GetRequestsView();
 
    void SetLimit(std::optional<size_t> new_limit) override;
 
    size_t GetLimitableHandlersCount() const override;
 
    void SetRpsRatelimit(std::optional<size_t> rps);
 
    void SetRpsRatelimitStatusCode(http::HttpStatus status_code);
 
    std::uint64_t GetTotalRequests() const override;
 
    void WriteMetrics(utils::statistics::Writer& writer) const;
 
private:
    std::unique_ptr<ServerImpl> pimpl_;
};
 
}  // namespace server
 
USERVER_NAMESPACE_END