Skip to content

Commit bd8097a

Browse files
document Wait() method parameters
1 parent 5e392c3 commit bd8097a

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

lib/Process/SubProcess.pm

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1091,16 +1091,27 @@ sub Read {
10911091
10921092
=over 4
10931093
1094-
=item Wait ()
1094+
=item Wait ( [ CONFIGURATIONS ] )
10951095
10961096
This method calls the C<Check()> method continuously for a started process
10971097
which was started with the C<Launch()> method until the C<Check()> method tells that
10981098
the process is finished.
10991099
1100-
If a C<TIMEOUT> is set through the C<setTimeout()> method the B<Manager Process> will
1101-
terminate the process after the C<TIMEOUT> is fulfilled.
1100+
If a C<TIMEOUT> is set the B<Manager Process> will terminate the process with
1101+
the C<Terminate()> method after the C<TIMEOUT> is fulfilled.
11021102
When a process times out an B<Error Code> of C< 4 > will be set.
11031103
1104+
B<Parameters:>
1105+
1106+
C<CONFIGURATIONS> - is a list are passed in a hash like fashion, using key and value pairs.
1107+
1108+
B<Recognized Configurations:>
1109+
1110+
C<check> - is an integer that specifies the interval in which all processes should
1111+
be checked once.
1112+
1113+
C<timeout> - is an integer that specifies the maximal execution time in seconds.
1114+
11041115
B<Returns:> It returns C< 1 > when the process has finished correctly.
11051116
It returns C< 0 > when the process had to be terminated.
11061117
@@ -1197,17 +1208,28 @@ sub Wait {
11971208
11981209
=over 4
11991210
1200-
=item Run ()
1211+
=item Run ( [ CONFIGURATIONS ] )
12011212
12021213
This method starts the process calling the C<Launch()> method and then calls
12031214
the C<Wait()> method to wait until the process is finished.
12041215
1216+
B<Parameters:>
1217+
1218+
C<CONFIGURATIONS> - is a list are passed in a hash like fashion, using key and value pairs.
1219+
1220+
B<Recognized Configurations:>
1221+
1222+
C<check> - is an integer that specifies the interval in which all processes should
1223+
be checked once.
1224+
1225+
C<timeout> - is an integer that specifies the maximal execution time in seconds.
1226+
12051227
B<Returns:> It returns C< 1 > when the process was started and finished correctly.
12061228
It returns C< 0 > when the process could not be started or had to be terminated.
12071229
12081230
See L<Method C<Launch()>|/"Launch ()">
12091231
1210-
See L<Method C<Wait()>|/"Wait ()">
1232+
See L<Method C<Wait()>|/"Wait ( [ CONFIGURATIONS ] )">
12111233
12121234
=back
12131235

lib/Process/SubProcess/Group.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ be checked once.
710710
C<read | readtimeout> - is an integer that specifies the time in seconds to wait for output
711711
from the command for each C<Process::SubProcess> object.
712712
713-
C<timeout> - is an integer that specifies the maximal execution time in seconds
713+
C<timeout> - is an integer that specifies the maximal execution time in seconds
714714
of the whole B<Process Group> execution.
715715
716716
See L<Method C<Process::SubProcess::Terminate()>|Process::SubProcess/"Terminate ()">

0 commit comments

Comments
 (0)