C++ Server-Side SDK
LaunchDarkly SDK
All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | List of all members
launchdarkly::server_side::ConfigBuilder Class Reference

Public Types

using Result = Config
 

Public Member Functions

 ConfigBuilder (std::string sdk_key)
 
config::builders::EndpointsBuilderServiceEndpoints ()
 
config::builders::AppInfoBuilderAppInfo ()
 
config::builders::EventsBuilderEvents ()
 
config::builders::DataSystemBuilderDataSystem ()
 
config::builders::HttpPropertiesBuilderHttpProperties ()
 
config::builders::LoggingBuilderLogging ()
 
ConfigBuilderOffline (bool offline)
 If true, equivalent to setting Events().Disable() and DataSystem().Disable(). The effect is that all evaluations will return application-provided default values, and no network calls will be made.
 
tl::expected< Result, Error > Build () const
 

Constructor & Destructor Documentation

◆ ConfigBuilder()

launchdarkly::server_side::ConfigBuilder::ConfigBuilder ( std::string  sdk_key)
explicit

A minimal configuration consists of a LaunchDarkly SDK Key.

Parameters
sdk_keySDK Key.

Member Function Documentation

◆ AppInfo()

config::builders::AppInfoBuilder & launchdarkly::server_side::ConfigBuilder::AppInfo ( )

To include metadata about the application that is utilizing the SDK, pass in an AppInfoBuilder.

Parameters
builderAn AppInfoBuilder.
Returns
Reference to an AppInfoBuilder.

◆ Build()

tl::expected< Config, Error > launchdarkly::server_side::ConfigBuilder::Build ( ) const

Builds a Configuration, suitable for passing into an instance of Client.

Returns

◆ DataSystem()

config::builders::DataSystemBuilder & launchdarkly::server_side::ConfigBuilder::DataSystem ( )

Sets the configuration of the component that receives and stores feature flag data from LaunchDarkly.

Parameters
builderA DataSystemBuilder.
Returns
Reference to a DataSystemBuilder.

◆ Events()

config::builders::EventsBuilder & launchdarkly::server_side::ConfigBuilder::Events ( )

To tune settings related to event generation and delivery, pass an EventsBuilder.

Parameters
builderAn EventsBuilder.
Returns
Reference to an EventsBuilder.

◆ HttpProperties()

config::builders::HttpPropertiesBuilder & launchdarkly::server_side::ConfigBuilder::HttpProperties ( )

Sets the SDK's networking configuration, using an HttpPropertiesBuilder. The builder has methods for setting individual HTTP-related properties.

Parameters
builderA HttpPropertiesBuilder builder.
Returns
Reference to an HttpPropertiesBuilder.

◆ Logging()

config::builders::LoggingBuilder & launchdarkly::server_side::ConfigBuilder::Logging ( )

Sets the logging configuration for the SDK.

Parameters
builderA Logging builder.
Returns
Reference to a LoggingBuilder.

◆ Offline()

ConfigBuilder & launchdarkly::server_side::ConfigBuilder::Offline ( bool  offline)

If true, equivalent to setting Events().Disable() and DataSystem().Disable(). The effect is that all evaluations will return application-provided default values, and no network calls will be made.

This overrides specific configuration of events and/or data system, if present.

Returns
Reference to this.

◆ ServiceEndpoints()

config::builders::EndpointsBuilder & launchdarkly::server_side::ConfigBuilder::ServiceEndpoints ( )

To customize the ServiceEndpoints the SDK uses for streaming, polling, and events, pass in an EndpointsBuilder.

Parameters
builderAn EndpointsBuilder.
Returns
Reference to an EndpointsBuilder.

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