class Ethon::Multi

This class represents libcurl multi.

Public Class Methods

new(options = {}) click to toggle source

Create a new multi. Initialize curl in case it didn't happen before.

@example Create a new Multi.

Multi.new

@param [ Hash ] options The options.

@option options :socketdata [String]

Pass a pointer to whatever you want passed to the
curl_socket_callback's forth argument, the userp pointer. This is not
used by libcurl but only passed-thru as-is. Set the callback pointer
with CURLMOPT_SOCKETFUNCTION.

@option options :pipelining [Boolean]

Pass a long set to 1 to enable or 0 to disable. Enabling pipelining
on a multi handle will make it attempt to perform HTTP Pipelining as
far as possible for transfers using this handle. This means that if
you add a second request that can use an already existing connection,
the second request will be "piped" on the same connection rather than
being executed in parallel. (Added in 7.16.0)

@option options :timerfunction [Proc]

Pass a pointer to a function matching the curl_multi_timer_callback
prototype. This function will then be called when the timeout value
changes. The timeout value is at what latest time the application
should call one of the "performing" functions of the multi interface
(curl_multi_socket_action(3) and curl_multi_perform(3)) - to allow
libcurl to keep timeouts and retries etc to work. A timeout value of
-1 means that there is no timeout at all, and 0 means that the
timeout is already reached. Libcurl attempts to limit calling this
only when the fixed future timeout time actually changes. See also
CURLMOPT_TIMERDATA. This callback can be used instead of, or in
addition to, curl_multi_timeout(3). (Added in 7.16.0)

@option options :timerdata [String]

Pass a pointer to whatever you want passed to the
curl_multi_timer_callback's third argument, the userp pointer. This
is not used by libcurl but only passed-thru as-is. Set the callback
pointer with CURLMOPT_TIMERFUNCTION. (Added in 7.16.0)

@option options :maxconnects [Integer]

Pass a long. The set number will be used as the maximum amount of
simultaneously open connections that libcurl may cache. Default is
10, and libcurl will enlarge the size for each added easy handle to
make it fit 4 times the number of added easy handles.
By setting this option, you can prevent the cache size from growing
beyond the limit set by you.
When the cache is full, curl closes the oldest one in the cache to
prevent the number of open connections from increasing.
This option is for the multi handle's use only, when using the easy
interface you should instead use the CURLOPT_MAXCONNECTS option.
(Added in 7.16.3)

@option options :max_total_connections [Integer] Pass a long. The set number will be used as the maximum amount of simultaneously open connections in total. For each new session, libcurl will open a new connection up to the limit set by CURLMOPT_MAX_TOTAL_CONNECTIONS. When the limit is reached, the sessions will be pending until there are available connections. If CURLMOPT_PIPELINING is 1, libcurl will try to pipeline if the host is capable of it. The default value is 0, which means that there is no limit. However, for backwards compatibility, setting it to 0 when CURLMOPT_PIPELINING is 1 will not be treated as unlimited. Instead it will open only 1 connection and try to pipeline on it. (Added in 7.30.0)

@return [ Multi ] The new multi.

# File lib/ethon/multi.rb, line 78
def initialize(options = {})
  Curl.init
  set_attributes(options)
  init_vars
end

Public Instance Methods

set_attributes(options) click to toggle source

Set given options.

@example Set options.

multi.set_attributes(options)

@raise InvalidOption

@see initialize

@api private

# File lib/ethon/multi.rb, line 94
def set_attributes(options)
  options.each_pair do |key, value|
    unless respond_to?("#{key}=")
      raise Errors::InvalidOption.new(key)
    end
    method("#{key}=").call(value)
  end
end