Class: ChildProcess::AbstractProcess

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

Direct Known Subclasses

ProcessSpawnProcess

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:



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

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.



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

def leader
  @leader
end

Instance Method Details

#alive? ⇒ Boolean

Is this process running?

Returns:

  • (Boolean) 


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

def alive?
  started? && !exited?
end

#crashed? ⇒ Boolean

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

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/childprocess/abstract_process.rb', line 143

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

#exited? ⇒ Boolean

Did the process exit?

Returns:

  • (Boolean)

Raises:



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

def exited?
  raise SubclassResponsibility, "exited?"
end

#io ⇒ Object

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

Raises:



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

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:



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

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.



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/childprocess/abstract_process.rb', line 152

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:



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

def start
  launch_process
  @started = true

  self
end

#started? ⇒ Boolean

Has the process started?

Returns:

  • (Boolean) 


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

def started?
  @started
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:



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

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:



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

def wait
  raise SubclassResponsibility, "wait"
end