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

#include <endpoints_builder.hpp>

Public Member Functions

 EndpointsBuilder ()=default
 
EndpointsBuilderPollingBaseUrl (std::string url)
 
EndpointsBuilderStreamingBaseUrl (std::string url)
 
EndpointsBuilderEventsBaseUrl (std::string url)
 
EndpointsBuilderRelayProxyBaseURL (std::string const &url)
 
tl::expected< built::ServiceEndpoints, Error > Build () const
 

Friends

bool operator== (EndpointsBuilder< SDK > const &lhs, EndpointsBuilder< SDK > const &rhs)
 

Detailed Description

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

EndpointsBuilder allows for specification of LaunchDarkly service ServiceEndpoints.

Template Parameters
SDKType of SDK, such as ClientSDK or ServerSDK.

Constructor & Destructor Documentation

◆ EndpointsBuilder()

Constructs an EndpointsBuilder.

Member Function Documentation

◆ Build()

template<typename SDK >
tl::expected< built::ServiceEndpoints, Error > launchdarkly::config::shared::builders::EndpointsBuilder< SDK >::Build

Builds a ServiceEndpoints if the configuration is valid. If not, returns an error. If any streaming, polling, or events URL is set, then all URLs must be set.

Returns
Unique pointer to ServiceEndpoints, or error.

◆ EventsBaseUrl()

template<typename SDK >
EndpointsBuilder< SDK > & launchdarkly::config::shared::builders::EndpointsBuilder< SDK >::EventsBaseUrl ( std::string  url)

Sets a custom URL for the events service.

Parameters
urlURL to set.
Returns
Reference to this builder.

◆ PollingBaseUrl()

template<typename SDK >
EndpointsBuilder< SDK > & launchdarkly::config::shared::builders::EndpointsBuilder< SDK >::PollingBaseUrl ( std::string  url)

Sets a custom URL for the polling service.

Parameters
urlURL to set.
Returns
Reference to this builder.

◆ RelayProxyBaseURL()

template<typename SDK >
EndpointsBuilder< SDK > & launchdarkly::config::shared::builders::EndpointsBuilder< SDK >::RelayProxyBaseURL ( std::string const &  url)

Sets a custom URL for a Relay Proxy instance. The streaming, polling, and events URLs are set automatically.

Parameters
urlURL to set.
Returns
Reference to this builder.

◆ StreamingBaseUrl()

template<typename SDK >
EndpointsBuilder< SDK > & launchdarkly::config::shared::builders::EndpointsBuilder< SDK >::StreamingBaseUrl ( std::string  url)

Sets a custom URL for the streaming service.

Parameters
urlURL to set.
Returns
Reference to this builder.

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