Class: Temporalio::Client::Connection::RPCRetryOptions

Inherits:
Data
  • Object
show all
Defined in:
lib/temporalio/client/connection.rb,
lib/temporalio/client/connection.rb

Overview

Retry options for server calls when retry is enabled (which it is by default on all high-level Temporalio::Client calls). For most users, the default is preferred.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(initial_interval: 0.1, randomization_factor: 0.2, multiplier: 1.5, max_interval: 5.0, max_elapsed_time: 10.0, max_retries: 10) ⇒ RPCRetryOptions

Returns a new instance of RPCRetryOptions.



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/temporalio/client/connection.rb', line 88

def initialize(
  initial_interval: 0.1,
  randomization_factor: 0.2,
  multiplier: 1.5,
  max_interval: 5.0,
  max_elapsed_time: 10.0,
  max_retries: 10
)
  super
end

Instance Attribute Details

#initial_interval ⇒ Float

Returns Initial backoff interval, default 0.1.

Returns:

  • (Float) —

    Initial backoff interval, default 0.1.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def initial_interval
  @initial_interval
end

#max_elapsed_time ⇒ Float

Returns Maximum total time, default 10.0. Can use 0 for no max.

Returns:

  • (Float) —

    Maximum total time, default 10.0. Can use 0 for no max.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def max_elapsed_time
  @max_elapsed_time
end

#max_interval ⇒ Float

Returns Maximum backoff interval, default 5.0.

Returns:

  • (Float) —

    Maximum backoff interval, default 5.0.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def max_interval
  @max_interval
end

#max_retries ⇒ Integer

Returns Maximum number of retries, default 10.

Returns:

  • (Integer) —

    Maximum number of retries, default 10.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def max_retries
  @max_retries
end

#multiplier ⇒ Float

Returns Backoff multiplier, default 1.5.

Returns:

  • (Float) —

    Backoff multiplier, default 1.5.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def multiplier
  @multiplier
end

#randomization_factor ⇒ Float

Returns Randomization jitter to add, default 0.2.

Returns:

  • (Float) —

    Randomization jitter to add, default 0.2.



87
88
89
 
# File 'lib/temporalio/client/connection.rb', line 87

def randomization_factor
  @randomization_factor
end