userver: clients::http::Response Class Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Types | Public Member Functions | Static Public Member Functions | List of all members
clients::http::Response Class Referencefinal

Table of Contents

#include <userver/clients/http/response.hpp>

Detailed Description

Class that will be returned for successful request.

Definition at line 119 of file response.hpp.

Public Types

using CookiesMap = server::http::Cookie::CookiesMap
 

Public Member Functions

std::string & sink_string ()
 response string
 
std::string body () const &
 body as string
 
std::string && body () &&
 
std::string_view body_view () const
 body as string_view
 
const Headers & headers () const
 return reference to headers
 
Headers & headers ()
 
const CookiesMap & cookies () const
 
CookiesMap & cookies ()
 
Status status_code () const
 status_code
 
bool IsOk () const
 check status code
 
bool IsError () const
 
void raise_for_status () const
 
LocalStats GetStats () const
 
void SetStats (const LocalStats &stats)
 
void SetStatusCode (Status status_code)
 

Static Public Member Functions

static void RaiseForStatus (int code, const LocalStats &stats)
 

Member Typedef Documentation

◆ CookiesMap

using clients::http::Response::CookiesMap = server::http::Cookie::CookiesMap

Definition at line 121 of file response.hpp.

Member Function Documentation

◆ body() [1/2]

std::string && clients::http::Response::body ( ) &&
inline

Definition at line 130 of file response.hpp.

◆ body() [2/2]

std::string clients::http::Response::body ( ) const &
inline

body as string

Definition at line 129 of file response.hpp.

◆ body_view()

std::string_view clients::http::Response::body_view ( ) const
inline

body as string_view

Definition at line 133 of file response.hpp.

◆ cookies() [1/2]

CookiesMap & clients::http::Response::cookies ( )
inline

Definition at line 139 of file response.hpp.

◆ cookies() [2/2]

const CookiesMap & clients::http::Response::cookies ( ) const
inline

Definition at line 138 of file response.hpp.

◆ GetStats()

LocalStats clients::http::Response::GetStats ( ) const

returns statistics on request execution like count of opened sockets, connect time...

◆ headers() [1/2]

Headers & clients::http::Response::headers ( )
inline

Definition at line 137 of file response.hpp.

◆ headers() [2/2]

const Headers & clients::http::Response::headers ( ) const
inline

return reference to headers

Definition at line 136 of file response.hpp.

◆ IsError()

bool clients::http::Response::IsError ( ) const
inline

Definition at line 145 of file response.hpp.

◆ IsOk()

bool clients::http::Response::IsOk ( ) const
inline

check status code

Definition at line 144 of file response.hpp.

◆ SetStats()

void clients::http::Response::SetStats ( const LocalStats & stats)
inline

Definition at line 155 of file response.hpp.

◆ SetStatusCode()

void clients::http::Response::SetStatusCode ( Status status_code)
inline

Definition at line 156 of file response.hpp.

◆ sink_string()

std::string & clients::http::Response::sink_string ( )
inline

response string

Definition at line 126 of file response.hpp.

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