Debian Codegraph @

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