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

Configuration for an outgoing HTTP request. More...

#include <HttpClient.h>

Public Types

enum  Method : uint8_t {
  HttpGET ,
  HttpPOST ,
  HttpPUT ,
  HttpHEAD ,
  HttpDELETE ,
  HttpPATCH ,
  HttpOPTIONS
}
 

Public Attributes

Method method = HttpGET
 
StringSpan url
 Full URL including scheme (e.g. "https://example.com/path")
 
Span< const StringSpanheaderNames
 
Span< const StringSpanheaderValues
 
Span< const char > body
 Fixed request body.
 
uint64_t streamedBodySize = 0
 If > 0, caller must provide a HttpClientRequestBodyProvider.
 
uint32_t timeoutMs = 30000
 Request timeout in milliseconds (0 = no timeout)
 
bool allowRedirects = false
 

Detailed Description

Configuration for an outgoing HTTP request.

Member Data Documentation

◆ body

Span<const char> SC::HttpClientRequest::body

Fixed request body.

◆ streamedBodySize

uint64_t SC::HttpClientRequest::streamedBodySize = 0

If > 0, caller must provide a HttpClientRequestBodyProvider.

◆ timeoutMs

uint32_t SC::HttpClientRequest::timeoutMs = 30000

Request timeout in milliseconds (0 = no timeout)

◆ url

StringSpan SC::HttpClientRequest::url

Full URL including scheme (e.g. "https://example.com/path")


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