Class: Phronomy::Task::MappedBackend Private

Inherits:
Backend
  • Object
show all
Defined in:
lib/phronomy/task/mapped_backend.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Backend for Tasks created by #map.

A mapped task's lifecycle is driven entirely by the +on_complete+ callback of its source task — it never spawns a thread of its own. +MappedBackend+ transitions the owning task to +:running+ immediately on initialization so that +FSMSession+ treats it as an in-progress async action. Completion (or failure) is triggered externally via #transition! from the +on_complete+ callback registered by #map.

+await+ and +join+ block until #unblock is called, which #map arranges by registering a second +on_complete+ callback on the mapped task itself after the transform callback has been registered.

Instance Method Summary collapse

Methods inherited from Backend

#completed_error, #completed_value

Constructor Details

#initialize(task:) ⇒ MappedBackend

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of MappedBackend.



23
24
25
26
27
 
# File 'lib/phronomy/task/mapped_backend.rb', line 23

def initialize(task:, &)
  super
  @done_queue = Queue.new
  task.transition!(:running)
end

Instance Method Details

#alive? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns +false+ — a mapped task has no independent thread to kill.

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/phronomy/task/mapped_backend.rb', line 50

def alive?
  false
end

#await ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Blocks until the mapped task reaches a terminal state.

Returns:

  • (Object) —

    the mapped value

Raises:

  • (Exception) —

    if the source task or the map block raised an error



40
41
42
43
44
45
 
# File 'lib/phronomy/task/mapped_backend.rb', line 40

def await
  value, error = @done_queue.pop
  raise error if error

  value
end

#cancel! ⇒ self

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

No-op — mapped tasks carry no independent thread to cancel.

Returns:

  • (self) 


57
58
59
 
# File 'lib/phronomy/task/mapped_backend.rb', line 57

def cancel!
  self
end

#join(limit = nil) ⇒ Object?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Blocks until the mapped task completes, with an optional timeout.

Parameters:

  • limit (Numeric, nil) (defaults to: nil)

Returns:

  • (Object, nil) —

    +nil+ on timeout



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/phronomy/task/mapped_backend.rb', line 65

def join(limit = nil)
  if limit.nil?
    await
  else
    begin
      Timeout.timeout(limit) { await }
    rescue Timeout::Error
      nil
    end
  end
end

#unblock(value, error) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Unblocks +await+ / +join+. Called by Phronomy::Task#map after the mapped task reaches a terminal state.



32
33
34
 
# File 'lib/phronomy/task/mapped_backend.rb', line 32

def unblock(value, error)
  @done_queue.push([value, error])
end