server::handlers::ClientError Class Reference

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

Detailed Description

Exception class for situations when request preconditions have failed. Corresponds to HTTP code 400.

Examples

postgresql/functional_tests/basic_chaos/postgres_service.cpp, samples/postgres_service/postgres_service.cpp, and samples/redis_service/redis_service.cpp.

Definition at line 321 of file exceptions.hpp.

Inheritance diagram for server::handlers::ClientError:

Public Types
using	BaseType
using	HandlerErrorCode = handlers::HandlerErrorCode
using	ServiceErrorCode = handlers::ServiceErrorCode
using	InternalMessage = handlers::InternalMessage
using	ExternalBody = handlers::ExternalBody
using	ExtraHeaders = handlers::ExtraHeaders

Public Member Functions
HandlerErrorCode	GetCode () const
const std::string &	GetServiceCode () const
bool	IsExternalErrorBodyFormatted () const
const std::string &	GetExternalErrorBody () const
const formats::json::Value &	GetDetails () const
const Headers &	GetExtraHeaders () const

Static Public Attributes
static constexpr HandlerErrorCode	kDefaultCode

Member Typedef Documentation

BaseType

using server::handlers::ExceptionWithCode< Code >::BaseType

inherited

Definition at line 309 of file exceptions.hpp.

ExternalBody

using server::handlers::CustomHandlerException::ExternalBody = handlers::ExternalBody

inherited

Definition at line 206 of file exceptions.hpp.

ExtraHeaders

using server::handlers::CustomHandlerException::ExtraHeaders = handlers::ExtraHeaders

inherited

Definition at line 207 of file exceptions.hpp.

HandlerErrorCode

using server::handlers::CustomHandlerException::HandlerErrorCode = handlers::HandlerErrorCode

inherited

Definition at line 203 of file exceptions.hpp.

InternalMessage

using server::handlers::CustomHandlerException::InternalMessage = handlers::InternalMessage

inherited

Definition at line 205 of file exceptions.hpp.

ServiceErrorCode

using server::handlers::CustomHandlerException::ServiceErrorCode = handlers::ServiceErrorCode

inherited

Definition at line 204 of file exceptions.hpp.

Member Function Documentation

GetCode()

HandlerErrorCode server::handlers::CustomHandlerException::GetCode ( ) const

inlineinherited

Definition at line 286 of file exceptions.hpp.

GetDetails()

const formats::json::Value & server::handlers::CustomHandlerException::GetDetails ( ) const

inlineinherited

Definition at line 294 of file exceptions.hpp.

GetExternalErrorBody()

const std::string & server::handlers::CustomHandlerException::GetExternalErrorBody ( ) const

inlineinherited

Definition at line 292 of file exceptions.hpp.

GetExtraHeaders()

const Headers & server::handlers::CustomHandlerException::GetExtraHeaders ( ) const

inlineinherited

Definition at line 296 of file exceptions.hpp.

GetServiceCode()

const std::string & server::handlers::CustomHandlerException::GetServiceCode ( ) const

inlineinherited

Definition at line 288 of file exceptions.hpp.

IsExternalErrorBodyFormatted()

bool server::handlers::CustomHandlerException::IsExternalErrorBodyFormatted ( ) const

inlineinherited

Definition at line 290 of file exceptions.hpp.

Member Data Documentation

kDefaultCode

constexpr HandlerErrorCode server::handlers::ExceptionWithCode< Code >::kDefaultCode

staticconstexprinherited

Definition at line 308 of file exceptions.hpp.

---

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

• userver/server/handlers/exceptions.hpp