Class: Canopus::Runner

Inherits:

Object

• Object
• Canopus::Runner

Defined in:

sig/task.rbs

Defined Under Namespace

Classes: Output

Constant Summary

MAX_OUTPUTS =

Returns:

• (Integer)

MAX_CLOSERS =

Returns:

• (Integer)

STOP_GRACE_SECONDS =

Returns:

• (Float)

Instance Attribute Summary

• #active_index ⇒ Integer readonly

  Returns the value of attribute active_index.

Instance Method Summary

• #activate ⇒ Output
• #active ⇒ Output^?
• #close ⇒ nil
• #completed ⇒ Array[Output]
• #drain {|arg0, arg1, arg2| ... } ⇒ Object
• #entries ⇒ Array[Output]
• #initialize ⇒ Runner constructor

  A new instance of Runner.

• #pending? ⇒ Boolean
• #remove ⇒ Output^?
• #resize ⇒ void
• #run ⇒ Output
• #running? ⇒ Boolean
• #stop ⇒ Boolean
• #terminal ⇒ Tarazed::PTY^?

Constructor Details

#initialize ⇒ Runner

Returns a new instance of Runner.

Parameters:

• scrollback: (Integer)
• queue_limit_bytes: (Integer)
• terminal_factory: (Object)
• report: (Object)

# File 'sig/task.rbs', line 53

def initialize: (scrollback: Integer, queue_limit_bytes: Integer, ?terminal_factory: untyped, ?report: untyped) -> void

Instance Attribute Details

#active_index ⇒ Integer (readonly)

Returns the value of attribute active_index.

Returns:

• (Integer)

# File 'sig/task.rbs', line 52

def active_index
  @active_index
end

Instance Method Details

#activate ⇒ Output

Parameters:

• index (Integer)

Returns:

• (Output)

# File 'sig/task.rbs', line 58

def activate: (Integer index) -> Output

#active ⇒ Output^?

Returns:

• (Output, nil)

# File 'sig/task.rbs', line 55

def active: () -> Output?

#close ⇒ nil

Returns:

• (nil)

# File 'sig/task.rbs', line 67

def close: () -> nil

#completed ⇒ Array[Output]

Returns:

• (Array[Output])

# File 'sig/task.rbs', line 62

def completed: () -> Array[Output]

#drain(max_bytes:, max_seconds:) ⇒ Boolean #drain(max_bytes:, max_seconds:) ⇒ Boolean

Overloads:

• #drain(max_bytes:, max_seconds:) ⇒ Boolean

  Parameters:

  • max_bytes: (Integer)
  • max_seconds: (Numeric)

  Returns:

  • (Boolean)
• #drain(max_bytes:, max_seconds:) ⇒ Boolean

  Parameters:

  • max_bytes: (Integer)
  • max_seconds: (Numeric)

  Returns:

  • (Boolean)

Yields:

Yield Parameters:

• arg0 (Output)
• arg1 (String, nil)
• arg2 (Numeric)

Yield Returns:

• (Object)

# File 'sig/task.rbs', line 63

def drain: (max_bytes: Integer, ?max_seconds: Numeric) -> bool
| (max_bytes: Integer, ?max_seconds: Numeric) { (Output, String?, Numeric) -> untyped } -> bool

#entries ⇒ Array[Output]

Returns:

• (Array[Output])

# File 'sig/task.rbs', line 54

def entries: () -> Array[Output]

#pending? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/task.rbs', line 65

def pending?: () -> bool

#remove ⇒ Output^?

Parameters:

• index (Integer)

Returns:

• (Output, nil)

# File 'sig/task.rbs', line 59

def remove: (?Integer index) -> Output?

#resize ⇒ void

This method returns an undefined value.

Parameters:

• columns (Integer)
• rows (Integer)

# File 'sig/task.rbs', line 66

def resize: (Integer columns, Integer rows) -> void

#run ⇒ Output

Parameters:

• task (definition)

Returns:

• (Output)

# File 'sig/task.rbs', line 57

def run: (definition task) -> Output

#running? ⇒ Boolean

Parameters:

• output (Output, nil)

Returns:

• (Boolean)

# File 'sig/task.rbs', line 61

def running?: (?Output? output) -> bool

#stop ⇒ Boolean

Parameters:

• output (Output, nil)

Returns:

• (Boolean)

# File 'sig/task.rbs', line 60

def stop: (?Output? output) -> bool

#terminal ⇒ Tarazed::PTY^?

Returns:

• (Tarazed::PTY, nil)

# File 'sig/task.rbs', line 56

def terminal: () -> Tarazed::PTY?