Debian Codegraph @

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