Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
SC::HttpClient Struct Reference

Reusable HTTP backend/session owner. More...

#include <HttpClient.h>

Public Member Functions

 HttpClient (const HttpClient &)=delete
 
 HttpClient (HttpClient &&)=delete
 
HttpClientoperator= (const HttpClient &)=delete
 
HttpClientoperator= (HttpClient &&)=delete
 
Result init ()
 
Result close ()
 
bool isInitialized () const
 

Static Public Member Functions

static Result executeBlocking (const HttpClientRequest &request, HttpClientResponse &response, Span< char > bodyBuffer, size_t &bodyLength, const HttpClientOperationMemory &memory)
 Convenience helper executing a request synchronously on top of HttpClientOperation::poll.
 

Friends

struct HttpClientOperation
 
struct Internal
 

Detailed Description

Reusable HTTP backend/session owner.

Member Function Documentation

◆ executeBlocking()

static Result SC::HttpClient::executeBlocking ( const HttpClientRequest & request,
HttpClientResponse & response,
Span< char > bodyBuffer,
size_t & bodyLength,
const HttpClientOperationMemory & memory )
staticnodiscard

Convenience helper executing a request synchronously on top of HttpClientOperation::poll.

Parameters
requestRequest metadata
responseParsed response metadata
bodyBufferDestination for the response body
bodyLengthNumber of body bytes copied into bodyBuffer
memoryCaller-owned operation memory used for the blocking request
Returns
Result(true) on success, otherwise the request error

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