SC::HttpClientOperation Struct Reference

One in-flight HTTP request/response operation. More...

#include <HttpClient.h>

Public Member Functions
	HttpClientOperation (const HttpClientOperation &)=delete
	HttpClientOperation (HttpClientOperation &&)=delete
HttpClientOperation &	operator= (const HttpClientOperation &)=delete
HttpClientOperation &	operator= (HttpClientOperation &&)=delete
Result	init (HttpClient &client, const HttpClientOperationMemory &memory)
Result	close ()
Result	cancel ()
Result	start (const HttpClientRequest &request, HttpClientResponse &response, HttpClientOperationListener *listener=nullptr, HttpClientRequestBodyProvider *bodyProvider=nullptr)
	Starts a new request on this operation.
Result	poll (uint32_t timeoutMilliseconds=0)
	Processes queued backend events and optionally waits for more work.
void	setNotifier (HttpClientOperationNotifier *notifierValue)
	Registers an optional notifier used by adapters such as HttpClientAsyncT.
bool	isInitialized () const
bool	isRequestInFlight () const

Friends
struct	Internal
struct	HttpClientAppleCallbacks
struct	HttpClientLinuxCallbacks
struct	HttpClientWindowsCallbacks

Detailed Description

One in-flight HTTP request/response operation.

Member Function Documentation

poll()

Result SC::HttpClientOperation::poll ( uint32_t timeoutMilliseconds = 0 )

nodiscard

Processes queued backend events and optionally waits for more work.

Parameters

timeoutMilliseconds

Maximum time to wait for new events, 0 for non-blocking polling

Returns

Result(true) on success, otherwise the processing error

setNotifier()

void SC::HttpClientOperation::setNotifier ( HttpClientOperationNotifier * notifierValue )

inline

Registers an optional notifier used by adapters such as HttpClientAsyncT.

Parameters

notifierValue

Notifier receiving wake-up notifications, or nullptr

start()

Result SC::HttpClientOperation::start ( const HttpClientRequest & request, HttpClientResponse & response, HttpClientOperationListener * listener = nullptr, HttpClientRequestBodyProvider * bodyProvider = nullptr )

nodiscard

Starts a new request on this operation.

Parameters

request	Request metadata
response	Parsed response metadata storage updated as the request progresses
listener	Optional poll-driven response listener
bodyProvider	Optional request body provider for streamed uploads

Returns

Result(true) on success, otherwise the start error

---

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

• HttpClient.h