server::middlewares::CorsFactory Class Reference

#include <userver/server/middlewares/cors.hpp>

Detailed Description

Factory for server::middlewares::Cors.

The middleware handles CORS preflight requests and adds appropriate CORS headers to responses to allow cross-origin requests from web browsers. For additional information about CORS please see https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS.

Static options of <tt>CorsFactory</tt>:

Options inherited from components::RawComponentBase :

See also

server::middlewares::Cors

Definition at line 91 of file cors.hpp.

Inheritance diagram for server::middlewares::CorsFactory:

Public Member Functions
	CorsFactory (const components::ComponentConfig &, const components::ComponentContext &)
yaml_config::Schema	GetMiddlewareConfigSchema () const override
	This method should return the schema of a middleware configuration, if any. You may override it.
std::unique_ptr< HttpMiddlewareBase >	CreateChecked (const handlers::HttpHandlerBase &handler, yaml_config::YamlConfig middleware_config) const
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

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

Static Public Attributes
static constexpr std::string_view	kName = "cors-middleware"
	The default name of server::middlewares::CorsFactory component.

Protected Types
using	LoggableComponentBase = ComponentBase

Member Typedef Documentation

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.

GetMiddlewareConfigSchema()

yaml_config::Schema server::middlewares::CorsFactory::GetMiddlewareConfigSchema ( ) const

overridevirtual

This method should return the schema of a middleware configuration, if any. You may override it.

Reimplemented from server::middlewares::HttpMiddlewareFactoryBase.

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.

---

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

• userver/server/middlewares/cors.hpp