Class: ChildProcess::AbstractProcess

Inherits:
Object
  • Object
show all
Defined in:
lib/childprocess/abstract_process.rb

Direct Known Subclasses

JRuby::Process, Unix::Process, Windows::Process

Constant Summary collapse

POLL_INTERVAL = 
0.1

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ AbstractProcess

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.

Create a new process with the given args.

See Also:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/childprocess/abstract_process.rb', line 43

def initialize(args)
  unless args.all? { |e| e.kind_of?(String) }
    raise ArgumentError, "all arguments must be String: #{args.inspect}"
  end

  @args        = args
  @started     = false
  @exit_code   = nil
  @io          = nil
  @cwd         = nil
  @detach      = false
  @duplex      = false
  @leader      = false
  @environment = {}
end

Instance Attribute Details

#cwd ⇒ Object

Set the child’s current working directory.



25
26
27
 
# File 'lib/childprocess/abstract_process.rb', line 25

def cwd
  @cwd
end

#detach ⇒ Object

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



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

def detach
  @detach
end

#duplex ⇒ Object

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



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

def duplex
  @duplex
end

#environment ⇒ Object (readonly)

Modify the child’s environment variables



20
21
22
 
# File 'lib/childprocess/abstract_process.rb', line 20

def environment
  @environment
end

#exit_code ⇒ Object (readonly)

Returns the value of attribute exit_code.



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

def exit_code
  @exit_code
end

#leader ⇒ Object

Set this to true to make the child process the leader of a new process group

This can be used to make sure that all grandchildren are killed when the child process dies.



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

def leader
  @leader
end

Instance Method Details

#alive? ⇒ Boolean

Is this process running?

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/childprocess/abstract_process.rb', line 124

def alive?
  started? && !exited?
end

#crashed? ⇒ Boolean

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

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/childprocess/abstract_process.rb', line 134

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

#exited? ⇒ Boolean

Did the process exit?

Returns:

  • (Boolean)

Raises:



114
115
116
 
# File 'lib/childprocess/abstract_process.rb', line 114

def exited?
  raise SubclassResponsibility, "exited?"
end

#io ⇒ Object

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

Raises:



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

def io
  raise SubclassResponsibility, "io"
end

#pid ⇒ Integer

Returns the pid of the process after it has started.

Returns:

  • (Integer) —

    the pid of the process after it has started

Raises:



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

def pid
  raise SubclassResponsibility, "pid"
end

#poll_for_exit(timeout) ⇒ Object

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



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/childprocess/abstract_process.rb', line 143

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

#start ⇒ AbstractProcess

Launch the child process

Returns:



81
82
83
84
85
86
 
# File 'lib/childprocess/abstract_process.rb', line 81

def start
  launch_process
  @started = true

  self
end

#stop(timeout = 3) ⇒ Object

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

Parameters:

  • timeout (Integer) (defaults to: 3) —

    (3) Seconds to wait before trying the next method.

Raises:



94
95
96
 
# File 'lib/childprocess/abstract_process.rb', line 94

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

#wait ⇒ Integer

Block until the process has been terminated.

Returns:

  • (Integer) —

    The exit status of the process

Raises:



104
105
106
 
# File 'lib/childprocess/abstract_process.rb', line 104

def wait
  raise SubclassResponsibility, "wait"
end