Class: Segment::Analytics::BackoffPolicy

Inherits:
Object
  • Object
show all
Includes:
Defaults::BackoffPolicy
Defined in:
lib/segment/analytics/backoff_policy.rb

Constant Summary

Constants included from Defaults::BackoffPolicy

Defaults::BackoffPolicy::MAX_TIMEOUT_MS, Defaults::BackoffPolicy::MIN_TIMEOUT_MS, Defaults::BackoffPolicy::MULTIPLIER, Defaults::BackoffPolicy::RANDOMIZATION_FACTOR

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ BackoffPolicy

Returns a new instance of BackoffPolicy.

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :min_timeout_ms (Numeric) —

    The minimum backoff timeout

  • :max_timeout_ms (Numeric) —

    The maximum backoff timeout

  • :multiplier (Numeric) —

    The value to multiply the current interval with for each retry attempt

  • :randomization_factor (Numeric) —

    The randomization factor to use to create a range around the retry interval



17
18
19
20
21
22
23
24
 
# File 'lib/segment/analytics/backoff_policy.rb', line 17

def initialize(opts = {})
  @min_timeout_ms = opts[:min_timeout_ms] || MIN_TIMEOUT_MS
  @max_timeout_ms = opts[:max_timeout_ms] || MAX_TIMEOUT_MS
  @multiplier = opts[:multiplier] || MULTIPLIER
  @randomization_factor = opts[:randomization_factor] || RANDOMIZATION_FACTOR

  @attempts = 0
end

Instance Method Details

#next_interval ⇒ Numeric

Returns the next backoff interval, in milliseconds.

Returns:

  • (Numeric) —

    the next backoff interval, in milliseconds.



27
28
29
30
31
32
33
34
 
# File 'lib/segment/analytics/backoff_policy.rb', line 27

def next_interval
  interval = @min_timeout_ms * (@multiplier**@attempts)
  interval = add_jitter(interval, @randomization_factor)

  @attempts += 1

  [interval, @max_timeout_ms].min
end