Module: HTTPX::Plugins::CircuitBreaker::OptionsMethods

Defined in:
lib/httpx/plugins/circuit_breaker.rb

Instance Method Summary collapse

Instance Method Details

#option_circuit_breaker_break_in(value) ⇒ Object

Raises:

  • (TypeError) 


106
107
108
109
110
111
 
# File 'lib/httpx/plugins/circuit_breaker.rb', line 106

def option_circuit_breaker_break_in(value)
  timeout = Float(value)
  raise TypeError, ":circuit_breaker_break_in must be positive" unless timeout.positive?

  timeout
end

#option_circuit_breaker_break_on(value) ⇒ Object

Raises:

  • (TypeError) 


120
121
122
123
124
 
# File 'lib/httpx/plugins/circuit_breaker.rb', line 120

def option_circuit_breaker_break_on(value)
  raise TypeError, ":circuit_breaker_break_on must be called with the response" unless value.respond_to?(:call)

  value
end

#option_circuit_breaker_half_open_drip_rate(value) ⇒ Object

Raises:

  • (TypeError) 


113
114
115
116
117
118
 
# File 'lib/httpx/plugins/circuit_breaker.rb', line 113

def option_circuit_breaker_half_open_drip_rate(value)
  ratio = Float(value)
  raise TypeError, ":circuit_breaker_half_open_drip_rate must be a number between 0 and 1" unless (0..1).cover?(ratio)

  ratio
end

#option_circuit_breaker_max_attempts(value) ⇒ Object

Raises:

  • (TypeError) 


92
93
94
95
96
97
 
# File 'lib/httpx/plugins/circuit_breaker.rb', line 92

def option_circuit_breaker_max_attempts(value)
  attempts = Integer(value)
  raise TypeError, ":circuit_breaker_max_attempts must be positive" unless attempts.positive?

  attempts
end

#option_circuit_breaker_reset_attempts_in(value) ⇒ Object

Raises:

  • (TypeError) 


99
100
101
102
103
104
 
# File 'lib/httpx/plugins/circuit_breaker.rb', line 99

def option_circuit_breaker_reset_attempts_in(value)
  timeout = Float(value)
  raise TypeError, ":circuit_breaker_reset_attempts_in must be positive" unless timeout.positive?

  timeout
end