Class: Jongleur::Task

Inherits:
Struct
  • Object
show all
Defined in:
lib/jongleur.rb

Overview

a Task is a representation of the status of an executable Jongleur class, i.e. a class derived from WorkerTask and the process that’s executing that class

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#exit_status ⇒ Integer, Nil

Usually 0 for success, 1 for error or Nil otherwise

Returns:

  • (Integer, Nil) —

    the process’s return code when the process is exited



29
 
# File 'lib/jongleur.rb', line 29

Task = Struct.new(:name, :pid, :running, :exit_status, :success_status)

#name ⇒ String

Returns the class (WorkerTask) name that’s executing this process.

Returns:

  • (String) —

    the class (WorkerTask) name that’s executing this process



29
 
# File 'lib/jongleur.rb', line 29

Task = Struct.new(:name, :pid, :running, :exit_status, :success_status)

#pid ⇒ Integer

Returns the process id accoding to the OS.

Returns:

  • (Integer) —

    the process id accoding to the OS



29
 
# File 'lib/jongleur.rb', line 29

Task = Struct.new(:name, :pid, :running, :exit_status, :success_status)

#running ⇒ Boolean

Returns true if the process is running.

Returns:

  • (Boolean) —

    true if the process is running



29
 
# File 'lib/jongleur.rb', line 29

Task = Struct.new(:name, :pid, :running, :exit_status, :success_status)

#success_status ⇒ Boolean, Nil

Returns true if process finished successfully, false if it didn’t or nil if process didn’t exit properly.

Returns:

  • (Boolean, Nil) —

    true if process finished successfully, false if it didn’t or nil if process didn’t exit properly.



29
 
# File 'lib/jongleur.rb', line 29

Task = Struct.new(:name, :pid, :running, :exit_status, :success_status)