Module: LaunchDarkly::Impl::DataSystem::Synchronizer Private

Defined in:
lib/ldclient-rb/impl/data_system.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Mixin that defines the required methods of a synchronizer implementation. A synchronizer is a component capable of synchronizing data from an external data source, such as a streaming or polling API.

It is responsible for yielding Update objects that represent the current state of the data source, including any changes that have occurred since the last synchronization.

Application code should not need to implement this directly; it is used internally by the SDK.

Since:

  • 5.5.0

Instance Method Summary collapse

Instance Method Details

#sync {|Update| ... } ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sync should begin the synchronization process for the data source, yielding Update objects until the connection is closed or an unrecoverable error occurs.

Yields:

  • (Update) —

    Yields Update objects as synchronization progresses

Raises:

  • (NotImplementedError)

Since:

  • 5.5.0



291
292
293
 
# File 'lib/ldclient-rb/impl/data_system.rb', line 291

def sync
  raise NotImplementedError, "#{self.class} must implement #sync"
end