Options for constructing a CurlAssetAccessor. More...

#include <CesiumCurl/CurlAssetAccessor.h>

Public Attributes
std::string	userAgent {"Mozilla/5.0 Cesium Native CurlAssetAccessor"}
	The `User-Agent` header to include with each request.

std::vector< CesiumAsync::IAssetAccessor::THeader >	requestHeaders {}
	Request headers to automatically include in each request.

bool	allowDirectoryCreation {false}
	Whether a PUT or POST to a `file:` URL is allowed to create file system directories to hold the target file.

std::string	certificatePath {}
	The path to TLS certificates. If non-empty, this will be provided to libcurl as `CURLOPT_CAPATH`.

std::string	certificateFile {}
	A file containing TLS certificates. If non-empty, this will be provided to libcurl as `CURLOPT_CAINFO`.

bool	doGlobalInit {true}
	Whether to call `curl_global_init(CURL_GLOBAL_ALL)` at construction time and `curl_global_cleanup()` at destruction time. Only set this to false if the initialization and cleanup are done elsewhere.

Detailed Description

Options for constructing a CurlAssetAccessor.

Definition at line 43 of file CurlAssetAccessor.h.

Member Data Documentation

◆ allowDirectoryCreation

bool CesiumCurl::CurlAssetAccessorOptions::allowDirectoryCreation {false}

Whether a PUT or POST to a file: URL is allowed to create file system directories to hold the target file.

This property has no effect when targetting a version of iOS prior to 13.

Definition at line 63 of file CurlAssetAccessor.h.

◆ certificateFile

std::string CesiumCurl::CurlAssetAccessorOptions::certificateFile {}

A file containing TLS certificates. If non-empty, this will be provided to libcurl as CURLOPT_CAINFO.

Definition at line 75 of file CurlAssetAccessor.h.

◆ certificatePath

std::string CesiumCurl::CurlAssetAccessorOptions::certificatePath {}

The path to TLS certificates. If non-empty, this will be provided to libcurl as CURLOPT_CAPATH.

Definition at line 69 of file CurlAssetAccessor.h.

◆ doGlobalInit

bool CesiumCurl::CurlAssetAccessorOptions::doGlobalInit {true}

Whether to call curl_global_init(CURL_GLOBAL_ALL) at construction time and curl_global_cleanup() at destruction time. Only set this to false if the initialization and cleanup are done elsewhere.

Definition at line 82 of file CurlAssetAccessor.h.

◆ requestHeaders

std::vector<CesiumAsync::IAssetAccessor::THeader> CesiumCurl::CurlAssetAccessorOptions::requestHeaders {}

Request headers to automatically include in each request.

Request headers passed to CurlAssetAccessor::get or CurlAssetAccessor::request take precendence over these.

Definition at line 55 of file CurlAssetAccessor.h.

◆ userAgent

std::string CesiumCurl::CurlAssetAccessorOptions::userAgent {"Mozilla/5.0 Cesium Native CurlAssetAccessor"}

The User-Agent header to include with each request.

Definition at line 47 of file CurlAssetAccessor.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumCurl/include/CesiumCurl/CurlAssetAccessor.h

Public Attributes