libCZI
Reading and Writing CZI documents made easy
Public Types | List of all members
libCZI::StreamsFactory::StreamProperties Class Reference

Here the keys for the property-bag with options for creating a stream-object are gathered. More...

#include <libCZI_StreamsLib.h>

Public Types

enum  {
  kCurlHttp_Proxy = 100 , kCurlHttp_UserAgent = 101 , kCurlHttp_Timeout = 102 , kCurlHttp_ConnectTimeout = 103 ,
  kCurlHttp_Xoauth2Bearer = 104 , kCurlHttp_Cookie = 105 , kCurlHttp_SslVerifyPeer = 106 , kCurlHttp_SslVerifyHost = 107 ,
  kCurlHttp_FollowLocation = 108 , kCurlHttp_MaxRedirs = 109 , kCurlHttp_CaInfo = 110 , kCurlHttp_CaInfoBlob = 111 ,
  kAzureBlob_AuthenticationMode = 200
}
 Values that identify properties in the property-bag for constructing a stream-object. More...
 

Detailed Description

Here the keys for the property-bag with options for creating a stream-object are gathered.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Values that identify properties in the property-bag for constructing a stream-object.

Enumerator
kCurlHttp_Proxy 

For CurlHttpInputStream, type string: gives the proxy to use, c.f. https://curl.se/libcurl/c/CURLOPT_PROXY.html for more information.

kCurlHttp_UserAgent 

For CurlHttpInputStream, type string: gives the user agent to use, c.f. https://curl.se/libcurl/c/CURLOPT_USERAGENT.html for more information.

kCurlHttp_Timeout 

For CurlHttpInputStream, type int32: gives the timeout in seconds, c.f. https://curl.se/libcurl/c/CURLOPT_TIMEOUT.html for more information.

kCurlHttp_ConnectTimeout 

For CurlHttpInputStream, type int32: gives the timeout in seconds for the connection phase, c.f. https://curl.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html for more information.

kCurlHttp_Xoauth2Bearer 

For CurlHttpInputStream, type string: gives an OAuth2.0 access token, c.f. https://curl.se/libcurl/c/CURLOPT_XOAUTH2_BEARER.html for more information.

kCurlHttp_Cookie 

For CurlHttpInputStream, type string: gives a cookie, c.f. https://curl.se/libcurl/c/CURLOPT_COOKIE.html for more information.

kCurlHttp_SslVerifyPeer 

For CurlHttpInputStream, type bool: a boolean indicating whether the SSL-certificate of the remote host is to be verified, c.f. https://curl.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html for more information.

kCurlHttp_SslVerifyHost 

For CurlHttpInputStream, type bool: a boolean indicating whether the SSL-certificate's name is to be verified against host, c.f. https://curl.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html for more information.

kCurlHttp_FollowLocation 

For CurlHttpInputStream, type bool: a boolean indicating whether redirects are to be followed, c.f. https://curl.se/libcurl/c/CURLOPT_FOLLOWLOCATION.html for more information.

kCurlHttp_MaxRedirs 

For CurlHttpInputStream, type int32: gives the maximum number of redirects to follow, c.f. https://curl.se/libcurl/c/CURLOPT_MAXREDIRS.html for more information.

kCurlHttp_CaInfo 

For CurlHttpInputStream, type string: gives the directory to check for CA certificate bundle , c.f. https://curl.se/libcurl/c/CURLOPT_CAINFO.html for more information.

kCurlHttp_CaInfoBlob 

For CurlHttpInputStream, type string: give PEM encoded content holding one or more certificates to verify the HTTPS server with, c.f. https://curl.se/libcurl/c/CURLOPT_CAINFO_BLOB.html for more information.

kAzureBlob_AuthenticationMode 

For AzureBlobInputStream, type string: specifies how authentication is to be done (c.f. https://learn.microsoft.com/en-us/azure/storage/blobs/quickstart-blobs-c-plus-plus?tabs=managed-identity%2Croles-azure-portal#authenticate-to-azure-and-authorize-access-to-blob-data). Possible values are: "DefaultAzureCredential", "EnvironmentCredential", "AzureCliCredential", "ManagedIdentityCredential", "WorkloadIdentityCredential", "ConnectionString". The default is: "DefaultAzureCredential".

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