Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Hub.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::Hub 3pm"
61 .TH Test2::EventFacet::Hub 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::Hub \- Facet for the hubs an event passes through.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 These are a record of the hubs an event passes through. Most recent hub is the
71 first one in the list.
72 .SH "FACET FIELDS"
73 .IX Header "FACET FIELDS"
74 .ie n .IP "$string = $trace\->{details}" 4
75 .el .IP "\f(CW$string\fR = \f(CW$trace\fR\->{details}" 4
76 .IX Item "$string = $trace->{details}"
77 .PD 0
78 .ie n .IP "$string = $trace\->\fBdetails()\fR" 4
79 .el .IP "\f(CW$string\fR = \f(CW$trace\fR\->\fBdetails()\fR" 4
80 .IX Item "$string = $trace->details()"
81 .PD
82 The hub class or subclass
83 .ie n .IP "$int = $trace\->{pid}" 4
84 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{pid}" 4
85 .IX Item "$int = $trace->{pid}"
86 .PD 0
87 .ie n .IP "$int = $trace\->\fBpid()\fR" 4
88 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fBpid()\fR" 4
89 .IX Item "$int = $trace->pid()"
90 .PD
91 PID of the hub this event was sent to.
92 .ie n .IP "$int = $trace\->{tid}" 4
93 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{tid}" 4
94 .IX Item "$int = $trace->{tid}"
95 .PD 0
96 .ie n .IP "$int = $trace\->\fBtid()\fR" 4
97 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fBtid()\fR" 4
98 .IX Item "$int = $trace->tid()"
99 .PD
100 The thread ID of the hub the event was sent to.
101 .ie n .IP "$hid = $trace\->{hid}" 4
102 .el .IP "\f(CW$hid\fR = \f(CW$trace\fR\->{hid}" 4
103 .IX Item "$hid = $trace->{hid}"
104 .PD 0
105 .ie n .IP "$hid = $trace\->\fBhid()\fR" 4
106 .el .IP "\f(CW$hid\fR = \f(CW$trace\fR\->\fBhid()\fR" 4
107 .IX Item "$hid = $trace->hid()"
108 .PD
109 The ID of the hub that the event was send to.
110 .ie n .IP "$huuid = $trace\->{huuid}" 4
111 .el .IP "\f(CW$huuid\fR = \f(CW$trace\fR\->{huuid}" 4
112 .IX Item "$huuid = $trace->{huuid}"
113 .PD 0
114 .ie n .IP "$huuid = $trace\->\fBhuuid()\fR" 4
115 .el .IP "\f(CW$huuid\fR = \f(CW$trace\fR\->\fBhuuid()\fR" 4
116 .IX Item "$huuid = $trace->huuid()"
117 .PD
118 The UUID of the hub that the event was sent to.
119 .ie n .IP "$int = $trace\->{nested}" 4
120 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{nested}" 4
121 .IX Item "$int = $trace->{nested}"
122 .PD 0
123 .ie n .IP "$int = $trace\->\fBnested()\fR" 4
124 .el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fBnested()\fR" 4
125 .IX Item "$int = $trace->nested()"
126 .PD
127 How deeply nested the hub was.
128 .ie n .IP "$bool = $trace\->{buffered}" 4
129 .el .IP "\f(CW$bool\fR = \f(CW$trace\fR\->{buffered}" 4
130 .IX Item "$bool = $trace->{buffered}"
131 .PD 0
132 .ie n .IP "$bool = $trace\->\fBbuffered()\fR" 4
133 .el .IP "\f(CW$bool\fR = \f(CW$trace\fR\->\fBbuffered()\fR" 4
134 .IX Item "$bool = $trace->buffered()"
135 .PD
136 True if the event was buffered and not sent to the formatter independent of a
137 parent (This should never be set when nested is \f(CW0\fR or \f(CW\*(C`undef\*(C'\fR).
138 .SH SOURCE
139 .IX Header "SOURCE"
140 The source code repository for Test2 can be found at
141 <https://github.com/Test\-More/test\-more/>.
142 .SH MAINTAINERS
143 .IX Header "MAINTAINERS"
144 .IP "Chad Granum <[email protected]>" 4
145 .IX Item "Chad Granum <[email protected]>"
146 .SH AUTHORS
147 .IX Header "AUTHORS"
148 .IP "Chad Granum <[email protected]>" 4
149 .IX Item "Chad Granum <[email protected]>"
150 .SH COPYRIGHT
151 .IX Header "COPYRIGHT"
152 Copyright 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/>