Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Tools::AsyncSubtest.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Tools::AsyncSubtest 3pm"
61 .TH Test2::Tools::AsyncSubtest 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Tools::AsyncSubtest \- Tools for writing async subtests.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 These are tools for writing async subtests. Async subtests are subtests which
71 can be started and stashed so that they can continue to receive events while
72 other events are also being generated.
73 .SH SYNOPSIS
74 .IX Header "SYNOPSIS"
75 .Vb 2
76 \& use Test2::Bundle::Extended;
77 \& use Test2::Tools::AsyncSubtest;
78 \&
79 \& my $ast1 = async_subtest local => sub {
80 \& ok(1, "Inside subtest");
81 \& };
82 \&
83 \& my $ast2 = fork_subtest child => sub {
84 \& ok(1, "Inside subtest in another process");
85 \& };
86 \&
87 \& # You must call finish on the subtests you create. Finish will wait/join on
88 \& # any child processes and threads.
89 \& $ast1\->finish;
90 \& $ast2\->finish;
91 \&
92 \& done_testing;
93 .Ve
94 .SH EXPORTS
95 .IX Header "EXPORTS"
96 Everything is exported by default.
97 .ie n .IP "$ast = async_subtest $name" 4
98 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR" 4
99 .IX Item "$ast = async_subtest $name"
100 .PD 0
101 .ie n .IP "$ast = async_subtest $name => sub { ... }" 4
102 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR => sub { ... }" 4
103 .IX Item "$ast = async_subtest $name => sub { ... }"
104 .ie n .IP "$ast = async_subtest $name => \e%hub_params, sub { ... }" 4
105 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
106 .IX Item "$ast = async_subtest $name => %hub_params, sub { ... }"
107 .PD
108 Create an async subtest. Run the codeblock if it is provided.
109 .ie n .IP "$ast = fork_subtest $name => sub { ... }" 4
110 .el .IP "\f(CW$ast\fR = fork_subtest \f(CW$name\fR => sub { ... }" 4
111 .IX Item "$ast = fork_subtest $name => sub { ... }"
112 .PD 0
113 .ie n .IP "$ast = fork_subtest $name => \e%hub_params, sub { ... }" 4
114 .el .IP "\f(CW$ast\fR = fork_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
115 .IX Item "$ast = fork_subtest $name => %hub_params, sub { ... }"
116 .PD
117 Create an async subtest. Run the codeblock in a forked process.
118 .ie n .IP "$ast = thread_subtest $name => sub { ... }" 4
119 .el .IP "\f(CW$ast\fR = thread_subtest \f(CW$name\fR => sub { ... }" 4
120 .IX Item "$ast = thread_subtest $name => sub { ... }"
121 .PD 0
122 .ie n .IP "$ast = thread_subtest $name => \e%hub_params, sub { ... }" 4
123 .el .IP "\f(CW$ast\fR = thread_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
124 .IX Item "$ast = thread_subtest $name => %hub_params, sub { ... }"
125 .PD
126 \&\fB** DISCOURAGED **\fR Threads are fragile. Thread tests are not even run unless
127 the AUTHOR_TESTING or T2_DO_THREAD_TESTS env vars are enabled.
128 .Sp
129 Create an async subtest. Run the codeblock in a thread.
130 .SH NOTES
131 .IX Header "NOTES"
132 .IP "Async Subtests are always buffered." 4
133 .IX Item "Async Subtests are always buffered."
134 Always buffered.
135 .IP "Do not use \fBdone_testing()\fR yourself." 4
136 .IX Item "Do not use done_testing() yourself."
137 using \fBdone_testing()\fR inside an async subtest will not work properly, the async
138 subtest must be finalized by calling \f(CW\*(C`$st\->finish\*(C'\fR.
139 .SH SOURCE
140 .IX Header "SOURCE"
141 The source code repository for Test2\-AsyncSubtest can be found at
142 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
143 .SH MAINTAINERS
144 .IX Header "MAINTAINERS"
145 .IP "Chad Granum <[email protected]>" 4
146 .IX Item "Chad Granum <[email protected]>"
147 .SH AUTHORS
148 .IX Header "AUTHORS"
149 .IP "Chad Granum <[email protected]>" 4
150 .IX Item "Chad Granum <[email protected]>"
151 .SH COPYRIGHT
152 .IX Header "COPYRIGHT"
153 Copyright Chad Granum <[email protected]>.
154 .PP
155 This program is free software; you can redistribute it and/or
156 modify it under the same terms as Perl itself.
157 .PP
158 See \fIhttp://dev.perl.org/licenses/\fR