doc/wait3.txt in proc-wait3-1.6.0 vs doc/wait3.txt in proc-wait3-1.7.0
- old
+ new
@@ -1,9 +1,8 @@
== Description
Adds the wait3, wait4, waitid, pause, sigsend, and getrusage methods to
- the Process module. For Ruby 1.8.4 or earlier, it also adds the getrlimit
- and setrlimit methods.
+ the Process module.
== Synopsis
require 'proc/wait3'
pid = fork{ sleep 1; exit 2 }
@@ -31,16 +30,18 @@
Proc.wait3(flags=0)
Delays its caller until a signal is received or one of its child processes
terminates or stops due to tracing.
- The return value is a ProcStat structure. The special global $? is also
- set. Raises a SystemError if there are no child processes.
+ The return value is a ProcStat structure and sets the $last_status global
+ variable. The special global $? is also set. Raises a SystemError if there
+ are no child processes.
Proc.wait4(pid, flags=0)
Waits for the given child process to exit. Returns a ProcStat structure.
- Also sets the $? special global variable.
+ The $last_status global variable is set. Also sets the $? special global
+ variable.
Proc.waitid(id_type, id_num=nil, options=nil)
Suspends the calling process until one of its children changes state,
returning immediately if a child process changed state prior to the call.
The state of a child process will change if it terminates, stops because
@@ -70,20 +71,10 @@
Returns a Proc::SigInfo struct and sets $?.
Not supported on all platforms.
-== Ruby 1.8.4 or earlier.
-Process.getrlimit(resource) => [cur_limit, max_limit]
- Returns a two element array consisting of the hard and soft limit
- for the current process for the given +resource+. The array consists of
- either numeric values or the word "infinite".
-
-Process.setrlimit(resource, current, max=nil) => nil
- Sets the resource limit for +resource+ to +current+ for the soft limit and
- +max+ for the hard limit, or to +current+ if +max+ is nil.
-
== Constants
=== Standard
Process::WAIT3_VERSION
Returns the version of this package as a string.
@@ -177,17 +168,17 @@
The wait3 and wait4 methods are similar to the wait2 and waitpid2
methods, except that they return much more information via the rusage
struct.
== Known Bugs
- None that I'm aware of. Please log any bugs on the RubyForge project
- page at http://www.rubyforge.org/projects/shards.
+ None that I'm aware of. Please log any bugs on the Github project
+ page at https://github.com/djberg96/proc-wait3.
== License
Artistic 2.0
== Copyright
- (C) 2003-2009 Daniel J. Berger
+ (C) 2003-2014 Daniel J. Berger
All Rights Reserved.
== Warranty
This package is provided "as is" and without any express or
implied warranties, including, without limitation, the implied