server::handlers::HandlerBase Class Reference

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

Detailed Description

Base class for the request handlers.

Each handler has an associated path and invoked only for the requests for that path.

Static options of server::handlers::HandlerBase :

Options inherited from components::ComponentBase :

Definition at line 25 of file handler_base.hpp.

Inheritance diagram for server::handlers::HandlerBase:

Public Member Functions
	HandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false)
virtual void	PrepareAndHandleRequest (http::HttpRequest &request, request::RequestContext &context) const =0
virtual void	ReportMalformedRequest (http::HttpRequest &) const
bool	IsMonitor () const
	Returns whether this is a monitoring handler.
const HandlerConfig &	GetConfig () const
	Returns handler config.
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Protected Types
using	HandlerErrorCode = handlers::HandlerErrorCode
using	InternalMessage = handlers::InternalMessage
using	ExternalBody = handlers::ExternalBody
using	ClientError = handlers::ClientError
using	InternalServerError = handlers::InternalServerError
using	LoggableComponentBase = ComponentBase

Member Typedef Documentation

ClientError

using server::handlers::HandlerBase::ClientError = handlers::ClientError

protected

Definition at line 57 of file handler_base.hpp.

ExternalBody

using server::handlers::HandlerBase::ExternalBody = handlers::ExternalBody

protected

Definition at line 55 of file handler_base.hpp.

HandlerErrorCode

using server::handlers::HandlerBase::HandlerErrorCode = handlers::HandlerErrorCode

protected

Definition at line 53 of file handler_base.hpp.

InternalMessage

using server::handlers::HandlerBase::InternalMessage = handlers::InternalMessage

protected

Definition at line 54 of file handler_base.hpp.

InternalServerError

using server::handlers::HandlerBase::InternalServerError = handlers::InternalServerError

protected

Definition at line 58 of file handler_base.hpp.

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated:

use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

IsMonitor()

bool server::handlers::HandlerBase::IsMonitor ( ) const

inline

Returns whether this is a monitoring handler.

Definition at line 44 of file handler_base.hpp.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 58 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 51 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

PrepareAndHandleRequest()

virtual void server::handlers::HandlerBase::PrepareAndHandleRequest ( http::HttpRequest &  request, request::RequestContext &  context  ) const

pure virtual

Parses request, executes processing routines, and fills response accordingly. Does not throw.

Implemented in server::handlers::HttpHandlerBase.

ReportMalformedRequest()

virtual void server::handlers::HandlerBase::ReportMalformedRequest ( http::HttpRequest &  ) const

inlinevirtual

Produces response to a request unrecognized by the protocol based on provided generic response. Does not throw. The error should be stored into response status and body prior to this call.

Reimplemented in server::handlers::HttpHandlerBase.

Definition at line 41 of file handler_base.hpp.

---

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

• userver/server/handlers/handler_base.hpp