Class: Async::Node
- Inherits:
-
Object
- Object
- Async::Node
- Defined in:
- lib/async/node.rb
Overview
A node in a tree, used for implementing the task hierarchy.
Instance Attribute Summary collapse
-
#annotation ⇒ Object
readonly
A useful identifier for the current node.
-
#children ⇒ Object
readonly
Returns the value of attribute children.
- #head ⇒ Object
-
#parent ⇒ Object
Returns the value of attribute parent.
- #tail ⇒ Object
Instance Method Summary collapse
- #annotate(annotation) ⇒ Object
- #backtrace(*arguments) ⇒ Object
-
#children? ⇒ Boolean
Whether this node has any children.
-
#consume ⇒ Object
If the node has a parent, and is #finished?, then remove this node from the parent.
- #description ⇒ Object
-
#finished? ⇒ Boolean
Whether the node can be consumed (deleted) safely.
-
#initialize(parent = nil, annotation: nil, transient: false) ⇒ Node
constructor
Create a new node in the tree.
- #print_hierarchy(out = $stdout, backtrace: true) ⇒ Object
- #root ⇒ Object
-
#stop(later = false) ⇒ Object
Attempt to stop the current node immediately, including all non-transient children.
- #stopped? ⇒ Boolean
-
#terminate ⇒ Object
Immediately terminate all children tasks, including transient tasks.
- #The parent node.=(parentnode. = (value)) ⇒ Object
- #to_s ⇒ Object (also: #inspect)
-
#transient? ⇒ Boolean
Represents whether a node is transient.
-
#traverse(&block) ⇒ Object
Traverse the task tree.
Constructor Details
#initialize(parent = nil, annotation: nil, transient: false) ⇒ Node
Create a new node in the tree.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/async/node.rb', line 59 def initialize(parent = nil, annotation: nil, transient: false) @parent = nil @children = nil @annotation = annotation @object_name = nil @transient = transient @head = nil @tail = nil if parent parent.add_child(self) end end |
Instance Attribute Details
#annotation ⇒ Object (readonly)
A useful identifier for the current node.
94 95 96 |
# File 'lib/async/node.rb', line 94 def annotation @annotation end |
#children ⇒ Object (readonly)
Returns the value of attribute children.
91 92 93 |
# File 'lib/async/node.rb', line 91 def children @children end |
#head ⇒ Object
82 83 84 |
# File 'lib/async/node.rb', line 82 def head @head end |
#parent ⇒ Object
Returns the value of attribute parent.
88 89 90 |
# File 'lib/async/node.rb', line 88 def parent @parent end |
#tail ⇒ Object
85 86 87 |
# File 'lib/async/node.rb', line 85 def tail @tail end |
Instance Method Details
#annotate(annotation) ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/async/node.rb', line 112 def annotate(annotation) if block_given? begin current_annotation = @annotation @annotation = annotation return yield ensure @annotation = current_annotation end else @annotation = annotation end end |
#backtrace(*arguments) ⇒ Object
138 139 140 |
# File 'lib/async/node.rb', line 138 def backtrace(*arguments) nil end |
#children? ⇒ Boolean
Whether this node has any children.
98 99 100 |
# File 'lib/async/node.rb', line 98 def children? @children && !@children.empty? end |
#consume ⇒ Object
If the node has a parent, and is #finished?, then remove this node from the parent.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/async/node.rb', line 191 def consume if parent = @parent and finished? parent.remove_child(self) # If we have children, then we need to move them to our the parent if they are not finished: if @children while child = @children.shift if child.finished? child.set_parent(nil) else parent.add_child(child) end end @children = nil end parent.consume end end |
#description ⇒ Object
126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/async/node.rb', line 126 def description @object_name ||= "#{self.class}:#{format '%#018x', object_id}#{@transient ? ' transient' : nil}" if annotation = self.annotation "#{@object_name} #{annotation}" elsif line = self.backtrace(0, 1)&.first "#{@object_name} #{line}" else @object_name end end |
#finished? ⇒ Boolean
Whether the node can be consumed (deleted) safely. By default, checks if the children set is empty.
185 186 187 |
# File 'lib/async/node.rb', line 185 def finished? @children.nil? || @children.finished? end |
#print_hierarchy(out = $stdout, backtrace: true) ⇒ Object
262 263 264 265 266 267 268 269 270 |
# File 'lib/async/node.rb', line 262 def print_hierarchy(out = $stdout, backtrace: true) self.traverse do |node, level| indent = "\t" * level out.puts "#{indent}#{node}" print_backtrace(out, indent, node) if backtrace end end |
#stop(later = false) ⇒ Object
Attempt to stop the current node immediately, including all non-transient children. Invokes #stop_children to stop all children.
246 247 248 249 |
# File 'lib/async/node.rb', line 246 def stop(later = false) # The implementation of this method may defer calling `stop_children`. stop_children(later) end |
#stopped? ⇒ Boolean
258 259 260 |
# File 'lib/async/node.rb', line 258 def stopped? @children.nil? end |
#terminate ⇒ Object
Immediately terminate all children tasks, including transient tasks. Internally invokes ‘stop(false)` on all children. This should be considered a last ditch effort and is used when closing the scheduler.
231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/async/node.rb', line 231 def terminate # Attempt to stop the current task immediately, and all children: stop(false) # If that doesn't work, take more serious action: @children&.each do |child| child.terminate end return @children.nil? end |
#The parent node.=(parentnode. = (value)) ⇒ Object
88 |
# File 'lib/async/node.rb', line 88 attr :parent |
#to_s ⇒ Object Also known as: inspect
142 143 144 |
# File 'lib/async/node.rb', line 142 def to_s "\#<#{self.description}>" end |
#transient? ⇒ Boolean
Represents whether a node is transient. Transient nodes are not considered when determining if a node is finished. This is useful for tasks which are internal to an object rather than explicit user concurrency. For example, a child task which is pruning a connection pool is transient, because it is not directly related to the parent task, and should not prevent the parent task from finishing.
108 109 110 |
# File 'lib/async/node.rb', line 108 def transient? @transient end |
#traverse(&block) ⇒ Object
Traverse the task tree.
216 217 218 219 220 |
# File 'lib/async/node.rb', line 216 def traverse(&block) return enum_for(:traverse) unless block_given? self.traverse_recurse(&block) end |