Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Control.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::EventFacet::Control 3pm"
61 .TH Test2::EventFacet::Control 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::EventFacet::Control \- Facet for hub actions and behaviors.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This facet is used when the event needs to give instructions to the Test2
71 internals.
72 .SH FIELDS
73 .IX Header "FIELDS"
74 .ie n .IP "$string = $control\->{details}" 4
75 .el .IP "\f(CW$string\fR = \f(CW$control\fR\->{details}" 4
76 .IX Item "$string = $control->{details}"
77 .PD 0
78 .ie n .IP "$string = $control\->\fBdetails()\fR" 4
79 .el .IP "\f(CW$string\fR = \f(CW$control\fR\->\fBdetails()\fR" 4
80 .IX Item "$string = $control->details()"
81 .PD
82 Human readable explanation for the special behavior.
83 .ie n .IP "$bool = $control\->{global}" 4
84 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->{global}" 4
85 .IX Item "$bool = $control->{global}"
86 .PD 0
87 .ie n .IP "$bool = $control\->\fBglobal()\fR" 4
88 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->\fBglobal()\fR" 4
89 .IX Item "$bool = $control->global()"
90 .PD
91 True if the event is global in nature and should be seen by all hubs.
92 .ie n .IP "$exit = $control\->{terminate}" 4
93 .el .IP "\f(CW$exit\fR = \f(CW$control\fR\->{terminate}" 4
94 .IX Item "$exit = $control->{terminate}"
95 .PD 0
96 .ie n .IP "$exit = $control\->\fBterminate()\fR" 4
97 .el .IP "\f(CW$exit\fR = \f(CW$control\fR\->\fBterminate()\fR" 4
98 .IX Item "$exit = $control->terminate()"
99 .PD
100 Defined if the test should immediately exit, the value is the exit code and may
101 be \f(CW0\fR.
102 .ie n .IP "$bool = $control\->{halt}" 4
103 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->{halt}" 4
104 .IX Item "$bool = $control->{halt}"
105 .PD 0
106 .ie n .IP "$bool = $control\->\fBhalt()\fR" 4
107 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->\fBhalt()\fR" 4
108 .IX Item "$bool = $control->halt()"
109 .PD
110 True if all testing should be halted immediately.
111 .ie n .IP "$bool = $control\->{has_callback}" 4
112 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->{has_callback}" 4
113 .IX Item "$bool = $control->{has_callback}"
114 .PD 0
115 .ie n .IP "$bool = $control\->\fBhas_callback()\fR" 4
116 .el .IP "\f(CW$bool\fR = \f(CW$control\fR\->\fBhas_callback()\fR" 4
117 .IX Item "$bool = $control->has_callback()"
118 .PD
119 True if the \f(CWcallback($hub)\fR method on the event should be called.
120 .ie n .IP "$encoding = $control\->{encoding}" 4
121 .el .IP "\f(CW$encoding\fR = \f(CW$control\fR\->{encoding}" 4
122 .IX Item "$encoding = $control->{encoding}"
123 .PD 0
124 .ie n .IP "$encoding = $control\->\fBencoding()\fR" 4
125 .el .IP "\f(CW$encoding\fR = \f(CW$control\fR\->\fBencoding()\fR" 4
126 .IX Item "$encoding = $control->encoding()"
127 .PD
128 This can be used to change the encoding from this event onward.
129 .ie n .IP "$phase = $control\->{phase}" 4
130 .el .IP "\f(CW$phase\fR = \f(CW$control\fR\->{phase}" 4
131 .IX Item "$phase = $control->{phase}"
132 .PD 0
133 .ie n .IP "$phase = $control\->\fBphase()\fR" 4
134 .el .IP "\f(CW$phase\fR = \f(CW$control\fR\->\fBphase()\fR" 4
135 .IX Item "$phase = $control->phase()"
136 .PD
137 Used to signal that a phase change has occurred. Currently only the perl END
138 phase is signaled.
139 .SH SOURCE
140 .IX Header "SOURCE"
141 The source code repository for Test2 can be found at
142 <https://github.com/Test\-More/test\-more/>.
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 <https://dev.perl.org/licenses/>