uvco::CurlRequest Class Reference

#include <curl.h>

Public Types
enum class	Method { GET , POST }

Public Member Functions
	CurlRequest (const CurlRequest &)=delete
	CurlRequest (CurlRequest &&)=delete
CurlRequest &	operator= (const CurlRequest &)=delete
CurlRequest &	operator= (CurlRequest &&)=delete
	~CurlRequest ()
void	setTimeoutMs (long timeoutMs)
MultiPromise< std::string >	start ()
std::optional< long >	statusCode () const
	Return the status code of the request after it has finished.

Private Member Functions
	CurlRequest (std::weak_ptr< UvCurlContext_ > context, Method method, std::string url)
	Initialize a GET request.
	CurlRequest (std::weak_ptr< UvCurlContext_ > context, Method method, std::string url, std::span< const std::pair< std::string, std::string > > fields)
	Initialize a POST request.

Private Attributes
std::unique_ptr< CurlRequestCore_ >	core_

Friends
class	Curl

Member Enumeration Documentation

Method

enum class uvco::CurlRequest::Method

strong

Enumerator
GET
POST

{ GET, POST };

Constructor & Destructor Documentation

CurlRequest() [1/4]

uvco::CurlRequest::CurlRequest ( const CurlRequest & )

delete

CurlRequest() [2/4]

uvco::CurlRequest::CurlRequest ( CurlRequest && )

delete

~CurlRequest()

uvco::CurlRequest::~CurlRequest ( )

default

CurlRequest() [3/4]

uvco::CurlRequest::CurlRequest ( std::weak_ptr< UvCurlContext_ > context, Method method, std::string url )

private

Initialize a GET request.

    : core_{std::make_unique<CurlRequestCore_>(std::move(context))} {
  switch (method) {
  case Method::GET:
    core_->initGet(std::move(url));
    break;
  default:
    BOOST_ASSERT(false);
  }
}

CurlRequest() [4/4]

uvco::CurlRequest::CurlRequest ( std::weak_ptr< UvCurlContext_ > context, Method method, std::string url, std::span< const std::pair< std::string, std::string > > fields )

private

Initialize a POST request.

    : core_{std::make_unique<CurlRequestCore_>(std::move(context))} {
 
  switch (method) {
  case Method::POST:
    core_->initPost(std::move(url), fields);
    break;
  default:
    BOOST_ASSERT(false);
  }
}

Member Function Documentation

operator=() [1/2]

CurlRequest & uvco::CurlRequest::operator= ( const CurlRequest & )

delete

operator=() [2/2]

CurlRequest & uvco::CurlRequest::operator= ( CurlRequest && )

delete

setTimeoutMs()

void uvco::CurlRequest::setTimeoutMs

(

long

timeoutMs

)

                                             {
  curl_easy_setopt(core_->easyHandle_, CURLOPT_TIMEOUT_MS, timeoutMs);
}

start()

MultiPromise< std::string > uvco::CurlRequest::start

(

)

Start the request. This method is a generator that yields received chunks of the remote resource. Make sure to always co_await the returned MultiPromise until receiving a std::nullopt.

The Curl instance must not be closed before the request has finished.

                                           {
  // Run transfer of response.
 
  while (true) {
    auto result = co_await *core_;
    if (result.has_value()) {
      co_yield std::move(result.value());
      continue;
    }
    // End of stream.
    break;
  }
 
  if (core_->curlStatus() && core_->curlStatus().value() != CURLE_OK) {
    throw CurlException(core_->curlStatus().value(), std::string{core_->url()});
  }
  if (core_->uvStatus() && core_->uvStatus().value() != 0) {
    throw UvcoException{
        core_->uvStatus().value(),
        fmt::format("Socket error while fetching {}", core_->url())};
  }
 
  co_return;
}

statusCode()

std::optional< long > uvco::CurlRequest::statusCode ( ) const

nodiscard

Return the status code of the request after it has finished.

                                                {
  return core_->responseCode();
}

Friends And Related Symbol Documentation

Curl

friend class Curl

friend

Member Data Documentation

core_

std::unique_ptr<CurlRequestCore_> uvco::CurlRequest::core_

private

---

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

• uvco/integrations/curl/curl.h
• uvco/integrations/curl/curl.cc