C++ Client-Side SDK
LaunchDarkly SDK
Public Member Functions | List of all members
launchdarkly::config::shared::builders::TlsBuilder< SDK > Class Template Reference

#include <http_properties_builder.hpp>

Public Member Functions

 TlsBuilder ()
 
 TlsBuilder (built::TlsOptions const &tls)
 
TlsBuilderSkipVerifyPeer (bool skip_verify_peer)
 
TlsBuilderCustomCAFile (std::string custom_ca_file)
 
built::TlsOptions Build () const
 

Detailed Description

template<typename SDK>
class launchdarkly::config::shared::builders::TlsBuilder< SDK >

Class used for building TLS options used within HttpProperties.

Template Parameters
SDKThe SDK type to build options for. This affects the default values of the built options.

Constructor & Destructor Documentation

◆ TlsBuilder() [1/2]

Construct a new TlsBuilder. The builder will use the default properties based on the SDK type. Setting a property will override the default value.

◆ TlsBuilder() [2/2]

template<typename SDK >
launchdarkly::config::shared::builders::TlsBuilder< SDK >::TlsBuilder ( built::TlsOptions const &  tls)

Create a TLS builder from an initial set of options. This can be useful when extending a set of options for a request.

Parameters
tlsThe TLS options to start with.

Member Function Documentation

◆ Build()

Builds the TLS options.

Returns
The built options.

◆ CustomCAFile()

template<typename SDK >
TlsBuilder< SDK > & launchdarkly::config::shared::builders::TlsBuilder< SDK >::CustomCAFile ( std::string  custom_ca_file)

Path to a file containing one or more CAs to verify the peer with. The certificate(s) must be PEM-encoded.

By default, the SDK uses the system's root CA bundle.

If the empty string is passed, this function will clear any existing CA bundle path previously set, and the system's root CA bundle will be used.

Parameters
custom_ca_fileFile path.
Returns
A reference to this builder.

◆ SkipVerifyPeer()

template<typename SDK >
TlsBuilder< SDK > & launchdarkly::config::shared::builders::TlsBuilder< SDK >::SkipVerifyPeer ( bool  skip_verify_peer)

Whether to skip verifying the remote peer's certificates.

Parameters
skip_verify_peerTrue to skip verification, false to verify.
Returns
A reference to this builder.

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