Debian Codegraph @

upstream/debian-unstable/man3/Test2::Tools::AsyncSubtest.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Tools::AsyncSubtest 3perl"
58 .TH Test2::Tools::AsyncSubtest 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Tools::AsyncSubtest \- Tools for writing async subtests.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 These are tools for writing async subtests. Async subtests are subtests which
68 can be started and stashed so that they can continue to receive events while
69 other events are also being generated.
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 2
73 \& use Test2::Bundle::Extended;
74 \& use Test2::Tools::AsyncSubtest;
75 \&
76 \& my $ast1 = async_subtest local => sub {
77 \& ok(1, "Inside subtest");
78 \& };
79 \&
80 \& my $ast2 = fork_subtest child => sub {
81 \& ok(1, "Inside subtest in another process");
82 \& };
83 \&
84 \& # You must call finish on the subtests you create. Finish will wait/join on
85 \& # any child processes and threads.
86 \& $ast1\->finish;
87 \& $ast2\->finish;
88 \&
89 \& done_testing;
90 .Ve
91 .SH EXPORTS
92 .IX Header "EXPORTS"
93 Everything is exported by default.
94 .ie n .IP "$ast = async_subtest $name" 4
95 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR" 4
96 .IX Item "$ast = async_subtest $name"
97 .PD 0
98 .ie n .IP "$ast = async_subtest $name => sub { ... }" 4
99 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR => sub { ... }" 4
100 .IX Item "$ast = async_subtest $name => sub { ... }"
101 .ie n .IP "$ast = async_subtest $name => \e%hub_params, sub { ... }" 4
102 .el .IP "\f(CW$ast\fR = async_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
103 .IX Item "$ast = async_subtest $name => %hub_params, sub { ... }"
104 .PD
105 Create an async subtest. Run the codeblock if it is provided.
106 .ie n .IP "$ast = fork_subtest $name => sub { ... }" 4
107 .el .IP "\f(CW$ast\fR = fork_subtest \f(CW$name\fR => sub { ... }" 4
108 .IX Item "$ast = fork_subtest $name => sub { ... }"
109 .PD 0
110 .ie n .IP "$ast = fork_subtest $name => \e%hub_params, sub { ... }" 4
111 .el .IP "\f(CW$ast\fR = fork_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
112 .IX Item "$ast = fork_subtest $name => %hub_params, sub { ... }"
113 .PD
114 Create an async subtest. Run the codeblock in a forked process.
115 .ie n .IP "$ast = thread_subtest $name => sub { ... }" 4
116 .el .IP "\f(CW$ast\fR = thread_subtest \f(CW$name\fR => sub { ... }" 4
117 .IX Item "$ast = thread_subtest $name => sub { ... }"
118 .PD 0
119 .ie n .IP "$ast = thread_subtest $name => \e%hub_params, sub { ... }" 4
120 .el .IP "\f(CW$ast\fR = thread_subtest \f(CW$name\fR => \e%hub_params, sub { ... }" 4
121 .IX Item "$ast = thread_subtest $name => %hub_params, sub { ... }"
122 .PD
123 \&\fB** DISCOURAGED **\fR Threads are fragile. Thread tests are not even run unless
124 the AUTHOR_TESTING or T2_DO_THREAD_TESTS env vars are enabled.
125 .Sp
126 Create an async subtest. Run the codeblock in a thread.
127 .SH NOTES
128 .IX Header "NOTES"
129 .IP "Async Subtests are always buffered." 4
130 .IX Item "Async Subtests are always buffered."
131 Always buffered.
132 .IP "Do not use \fBdone_testing()\fR yourself." 4
133 .IX Item "Do not use done_testing() yourself."
134 using \fBdone_testing()\fR inside an async subtest will not work properly, the async
135 subtest must be finalized by calling \f(CW\*(C`$st\->finish\*(C'\fR.
136 .SH SOURCE
137 .IX Header "SOURCE"
138 The source code repository for Test2\-AsyncSubtest can be found at
139 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
140 .SH MAINTAINERS
141 .IX Header "MAINTAINERS"
142 .IP "Chad Granum <[email protected]>" 4
143 .IX Item "Chad Granum <[email protected]>"
144 .SH AUTHORS
145 .IX Header "AUTHORS"
146 .PD 0
147 .IP "Chad Granum <[email protected]>" 4
148 .IX Item "Chad Granum <[email protected]>"
149 .PD
150 .SH COPYRIGHT
151 .IX Header "COPYRIGHT"
152 Copyright 2018 Chad Granum <[email protected]>.
153 .PP
154 This program is free software; you can redistribute it and/or
155 modify it under the same terms as Perl itself.
156 .PP
157 See \fIhttp://dev.perl.org/licenses/\fR