server::handlers::Ping Class Reference

Table of Contents

• Public Member Functions
• Static Public Member Functions
• Static Public Attributes
• Additional Inherited Members
• Detailed Description
• Static options:
• Member Function Documentation
• HandleRequestThrow()

Handler that returns HTTP 200 if the service is OK and able to process requests. More...

#include <userver/server/handlers/ping.hpp>

Inheritance diagram for server::handlers::Ping:

Collaboration diagram for server::handlers::Ping:

Public Member Functions
	Ping (const components::ComponentConfig &config, const components::ComponentContext &component_context)
std::string	HandleRequestThrow (const http::HttpRequest &request, request::RequestContext &context) const override
void	OnAllComponentsLoaded () override
Public Member Functions inherited from server::handlers::HttpHandlerBase
	HttpHandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false)
void	HandleRequest (request::RequestBase &request, request::RequestContext &context) const override
void	ReportMalformedRequest (request::RequestBase &request) const final
virtual const std::string &	HandlerName () const
const std::vector< http::HttpMethod > &	GetAllowedMethods () const
virtual logging::Level	GetLogLevelForResponseStatus (http::HttpStatus status) const
virtual FormattedErrorData	GetFormattedExternalErrorBody (const CustomHandlerException &exc) const
std::string	GetResponseDataForLoggingChecked (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const
Public Member Functions inherited from server::handlers::HandlerBase
	HandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false)
bool	IsMonitor () const
	Returns whether this is a monitoring handler.
const HandlerConfig &	GetConfig () const
	Returns handler config.
Public Member Functions inherited from components::LoggableComponentBase
	LoggableComponentBase (const ComponentConfig &, const ComponentContext &)
	LoggableComponentBase (LoggableComponentBase &&)=delete
	LoggableComponentBase (const LoggableComponentBase &)=delete
	~LoggableComponentBase () override=default
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()
Static Public Member Functions inherited from server::handlers::HttpHandlerBase
static yaml_config::Schema	GetStaticConfigSchema ()
Static Public Member Functions inherited from server::handlers::HandlerBase
static yaml_config::Schema	GetStaticConfigSchema ()
Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "handler-ping"
	The default name of server::handlers::Ping.

Additional Inherited Members
Protected Types inherited from server::handlers::HandlerBase
using	HandlerErrorCode = handlers::HandlerErrorCode
using	InternalMessage = handlers::InternalMessage
using	ExternalBody = handlers::ExternalBody
using	ClientError = handlers::ClientError
using	InternalServerError = handlers::InternalServerError
Protected Member Functions inherited from server::handlers::HttpHandlerBase
void	ThrowUnsupportedHttpMethod (const http::HttpRequest &request) const
virtual void	OnRequestCompleteThrow (const http::HttpRequest &, request::RequestContext &) const
virtual void	HandleStreamRequest (const server::http::HttpRequest &, server::request::RequestContext &, server::http::ResponseBodyStream &) const
virtual bool	IsStreamed () const
virtual bool	IsMethodStatisticIncluded () const
virtual bool	NeedCheckAuth () const
virtual std::string	GetRequestBodyForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &request_body) const
	Override it if you need a custom request body logging.
virtual std::string	GetResponseDataForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const
	Override it if you need a custom response data logging.
virtual void	ParseRequestData (const http::HttpRequest &, request::RequestContext &) const
virtual std::string	GetMetaType (const http::HttpRequest &) const

Detailed Description

Handler that returns HTTP 200 if the service is OK and able to process requests.

Uses components::ComponentContext::IsAnyComponentInFatalState() to detect fatal state (can not process requests).

Static options:

Inherits all the options from server::handlers::HttpHandlerBase HTTP Handlers and adds the following ones:

Name	Description	Default value
warmup-time-secs	how much time it needs to warmup the server	0

Examples

samples/production_service/production_service.cpp.

Definition at line 29 of file ping.hpp.

Member Function Documentation

HandleRequestThrow()

std::string server::handlers::Ping::HandleRequestThrow ( const http::HttpRequest &  request, request::RequestContext &  context  ) const

overridevirtual

The core method for HTTP request handling. request arg contains HTTP headers, full body, etc. The method should return response body.

Note

It is used only if IsStreamed() returned false.

Reimplemented from server::handlers::HttpHandlerBase.

---

The documentation for this class was generated from the following file:

• userver/server/handlers/ping.hpp