Method: Rbeapi::Eapilib::EapiConnection#timeouts

Defined in:
lib/rbeapi/eapilib.rb

#timeouts(opts = {}) ⇒ Object

Configures the connection timeout values (open_timeout and read_timeout). The timeout values are used for the eAPI connection.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • open_timeout (Float) —

    Number of seconds to wait for the eAPI connection to open. Default is DEFAULT_HTTP_OPEN_TIMEOUT.

  • read_timeout (Float) —

    Number of seconds to wait for one block of eAPI results to be read (via one read(2) call). Default is DEFAULT_HTTP_READ_TIMEOUT.



170
171
172
173
 
# File 'lib/rbeapi/eapilib.rb', line 170

def timeouts(opts = {})
  @open_timeout = opts.fetch(:open_timeout, DEFAULT_HTTP_OPEN_TIMEOUT)
  @read_timeout = opts.fetch(:read_timeout, DEFAULT_HTTP_READ_TIMEOUT)
end