Class: ChildProcess::AbstractProcess

Inherits:

Object

• Object
• ChildProcess::AbstractProcess

show all

Defined in:

lib/childprocess/abstract_process.rb

Constant Summary

POLL_INTERVAL =

0.1

Instance Attribute Summary (collapse)

• - (Object) detach

  Set this to true if you do not care about when or if the process quits.

• - (Object) duplex

  Set this to true if you want to write to the process' stdin (process.io.stdin).

• - (Object) exit_code readonly

  Returns the value of attribute exit_code.

Instance Method Summary (collapse)

• - (Boolean) alive?

  Is this process running?.

• - (Boolean) crashed?

  Returns true if the process has exited and the exit code was not 0.

• - (Boolean) exited?

  Did the process exit?.

• - (AbstractProcess) initialize(args) constructor private

  Create a new process with the given args.

• - (Object) io

  Returns a ChildProcess::AbstractIO subclass to configure the child's IO streams.

• - (Object) pid
• - (Object) poll_for_exit(timeout)

  Wait for the process to exit, raising a ChildProcess::TimeoutError if the timeout expires.

• - (AbstractProcess) start

  Launch the child process.

• - (Object) stop(timeout = 3)

  Forcibly terminate the process, using increasingly harsher methods if possible.

24
25
26
27
28
29
30

# File 'lib/childprocess/abstract_process.rb', line 24

def initialize(args)
  @args      = args
  @started   = false
  @exit_code = nil
  @detach    = false
  @duplex    = false
end

10
11
12

# File 'lib/childprocess/abstract_process.rb', line 10

def detach
  @detach
end

15
16
17

# File 'lib/childprocess/abstract_process.rb', line 15

def duplex
  @duplex
end

5
6
7

# File 'lib/childprocess/abstract_process.rb', line 5

def exit_code
  @exit_code
end

83
84
85

# File 'lib/childprocess/abstract_process.rb', line 83

def alive?
  started? && !exited?
end

93
94
95

# File 'lib/childprocess/abstract_process.rb', line 93

def crashed?
  exited? && @exit_code != 0
end

73
74
75

# File 'lib/childprocess/abstract_process.rb', line 73

def exited?
  raise SubclassResponsibility, "exited?"
end

36
37
38

# File 'lib/childprocess/abstract_process.rb', line 36

def io
  raise SubclassResponsibility, "io"
end

40
41
42

# File 'lib/childprocess/abstract_process.rb', line 40

def pid
  raise SubclassResponsibility, "pid"
end

102
103
104
105
106
107
108
109
110
111
112
113

# File 'lib/childprocess/abstract_process.rb', line 102

def poll_for_exit(timeout)
  log "polling #{timeout} seconds for exit"

  end_time = Time.now + timeout
  until (ok = exited?) || Time.now > end_time
    sleep POLL_INTERVAL
  end

  unless ok
    raise TimeoutError, "process still alive after #{timeout} seconds"
  end
end

50
51
52
53
54
55

# File 'lib/childprocess/abstract_process.rb', line 50

def start
  launch_process
  @started = true

  self
end

63
64
65

# File 'lib/childprocess/abstract_process.rb', line 63

def stop(timeout = 3)
  raise SubclassResponsibility, "stop"
end