Method: Concurrent::Future.execute

Defined in:

lib/concurrent/future.rb

.execute(opts = {}) { ... } ⇒ Future

Create a new Future object with the given block, execute it, and return the :pending object.

Examples:

future = Concurrent::Future.execute{ sleep(1); 42 }
future.state #=> :pending

Parameters:

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

  the options used to define the behavior at update and deref and to specify the executor on which to perform actions

Options Hash (opts):

• :executor (Executor) —

  when set use the given Executor instance. Three special values are also supported: :task returns the global task pool, :operation returns the global operation pool, and :immediate returns a new ImmediateExecutor object.

• :dup_on_deref (Boolean) — default: false —

  Call #dup before returning the data from Concern::Obligation#value

• :freeze_on_deref (Boolean) — default: false —

  Call #freeze before returning the data from Concern::Obligation#value

• :copy_on_deref (Proc) — default: nil —

  When calling the Concern::Obligation#value method, call the given proc passing the internal value as the sole argument then return the new value returned from the proc.

• :args (object, Array) —

  zero or more arguments to be passed the task block on execution

Yields:

• the asynchronous operation to perform

Returns:

• (Future) —

  the newly created Future in the :pending state

Raises:

• (ArgumentError) —

  if no block is given

# File 'lib/concurrent/future.rb', line 74

def self.execute(opts = {}, &block)
  Future.new(opts, &block).execute
end