C++ Client-Side SDK
LaunchDarkly SDK
Public Member Functions | Friends | List of all members
launchdarkly::config::shared::built::Events Class Referencefinal

Public Member Functions

 Events (bool enabled, std::size_t capacity, std::chrono::milliseconds flush_interval, std::string path, bool all_attributes_private, AttributeReference::SetType private_attrs, std::chrono::milliseconds delivery_retry_delay, std::size_t flush_workers, std::optional< std::size_t > context_keys_cache_capacity)
 
bool Enabled () const
 
std::size_t Capacity () const
 
std::chrono::milliseconds FlushInterval () const
 
std::chrono::milliseconds DeliveryRetryDelay () const
 
std::string const & Path () const
 
bool AllAttributesPrivate () const
 
AttributeReference::SetType const & PrivateAttributes () const
 
std::size_t FlushWorkers () const
 
std::optional< std::size_t > ContextKeysCacheCapacity () const
 

Friends

template<typename SDK >
class builders::EventsBuilder
 

Constructor & Destructor Documentation

◆ Events()

launchdarkly::config::shared::built::Events::Events ( bool  enabled,
std::size_t  capacity,
std::chrono::milliseconds  flush_interval,
std::string  path,
bool  all_attributes_private,
AttributeReference::SetType  private_attrs,
std::chrono::milliseconds  delivery_retry_delay,
std::size_t  flush_workers,
std::optional< std::size_t >  context_keys_cache_capacity 
)

Constructs configuration for the event subsystem.

Parameters
enabledIf event-sending is enabled. If false, no events will be sent to LaunchDarkly.
capacityHow many events can queue in memory before new events are dropped.
flush_intervalHow often events are automatically flushed to LaunchDarkly.
pathThe path component of the LaunchDarkly event delivery endpoint.
all_attributes_privateWhether all attributes should be treated as private or not.
private_attrsWhich attributes should be treated as private, if AllAttributesPrivate is false.
delivery_retry_delayHow long to wait before a redelivery attempt should be made.
flush_workersHow many workers to use for concurrent event delivery.
context_keys_cache_capacityMax number of unique context keys to hold in LRU cache used for context deduplication when generating index events.

Member Function Documentation

◆ AllAttributesPrivate()

bool launchdarkly::config::shared::built::Events::AllAttributesPrivate ( ) const

Whether all attributes should be considered private or not.

◆ Capacity()

std::size_t launchdarkly::config::shared::built::Events::Capacity ( ) const

Capacity of the event processor.

◆ ContextKeysCacheCapacity()

std::optional< std::size_t > launchdarkly::config::shared::built::Events::ContextKeysCacheCapacity ( ) const

Number of unique contexts to remember when deduplicating index events.

Returns
Max, or std::nullopt if not applicable.

◆ Enabled()

bool launchdarkly::config::shared::built::Events::Enabled ( ) const

Returns true if event-sending is enabled.

◆ FlushInterval()

std::chrono::milliseconds launchdarkly::config::shared::built::Events::FlushInterval ( ) const

Flush interval of the event processor, in milliseconds.

◆ FlushWorkers()

std::size_t launchdarkly::config::shared::built::Events::FlushWorkers ( ) const

Number of flush workers used for concurrent event delivery.

◆ Path()

std::string const & launchdarkly::config::shared::built::Events::Path ( ) const

Path component of the LaunchDarkly event delivery endpoint.

◆ PrivateAttributes()

AttributeReference::SetType const & launchdarkly::config::shared::built::Events::PrivateAttributes ( ) const

Set of individual attributes that should be considered private.


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