HOME

Mini Shell 1.0
Current File : //usr/local/share/man/man3/Test2::EventFacet::Trace.3pm
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test2::EventFacet::Trace 3"
.TH Test2::EventFacet::Trace 3 "2022-03-04" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::EventFacet::Trace \- Debug information for events
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Test2::API::Context object, as well as all Test2::Event types need to
have access to information about where they were created.  This object
represents that information.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test2::EventFacet::Trace;
\&
\&    my $trace = Test2::EventFacet::Trace\->new(
\&        frame => [$package, $file, $line, $subname],
\&    );
.Ve
.SH "FACET FIELDS"
.IX Header "FACET FIELDS"
.ie n .IP "$string = $trace\->{details}" 4
.el .IP "\f(CW$string\fR = \f(CW$trace\fR\->{details}" 4
.IX Item "$string = $trace->{details}"
.PD 0
.ie n .IP "$string = $trace\->\fIdetails()\fR" 4
.el .IP "\f(CW$string\fR = \f(CW$trace\fR\->\fIdetails()\fR" 4
.IX Item "$string = $trace->details()"
.PD
Used as a custom trace message that will be used \s-1INSTEAD\s0 of
\&\f(CW\*(C`at <FILE> line <LINE>\*(C'\fR when calling \f(CW\*(C`$trace\->debug\*(C'\fR.
.ie n .IP "$frame = $trace\->{frame}" 4
.el .IP "\f(CW$frame\fR = \f(CW$trace\fR\->{frame}" 4
.IX Item "$frame = $trace->{frame}"
.PD 0
.ie n .IP "$frame = $trace\->\fIframe()\fR" 4
.el .IP "\f(CW$frame\fR = \f(CW$trace\fR\->\fIframe()\fR" 4
.IX Item "$frame = $trace->frame()"
.PD
Get the call frame arrayref.
.Sp
.Vb 1
\&    [$package, $file, $line, $subname]
.Ve
.ie n .IP "$int = $trace\->{pid}" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{pid}" 4
.IX Item "$int = $trace->{pid}"
.PD 0
.ie n .IP "$int = $trace\->\fIpid()\fR" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fIpid()\fR" 4
.IX Item "$int = $trace->pid()"
.PD
The process \s-1ID\s0 in which the event was generated.
.ie n .IP "$int = $trace\->{tid}" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{tid}" 4
.IX Item "$int = $trace->{tid}"
.PD 0
.ie n .IP "$int = $trace\->\fItid()\fR" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fItid()\fR" 4
.IX Item "$int = $trace->tid()"
.PD
The thread \s-1ID\s0 in which the event was generated.
.ie n .IP "$id = $trace\->{cid}" 4
.el .IP "\f(CW$id\fR = \f(CW$trace\fR\->{cid}" 4
.IX Item "$id = $trace->{cid}"
.PD 0
.ie n .IP "$id = $trace\->\fIcid()\fR" 4
.el .IP "\f(CW$id\fR = \f(CW$trace\fR\->\fIcid()\fR" 4
.IX Item "$id = $trace->cid()"
.PD
The \s-1ID\s0 of the context that was used to create the event.
.ie n .IP "$uuid = $trace\->{uuid}" 4
.el .IP "\f(CW$uuid\fR = \f(CW$trace\fR\->{uuid}" 4
.IX Item "$uuid = $trace->{uuid}"
.PD 0
.ie n .IP "$uuid = $trace\->\fIuuid()\fR" 4
.el .IP "\f(CW$uuid\fR = \f(CW$trace\fR\->\fIuuid()\fR" 4
.IX Item "$uuid = $trace->uuid()"
.PD
The \s-1UUID\s0 of the context that was used to create the event. (If uuid tagging was
enabled)
.ie n .IP "($pkg, $file, $line, $subname) = $trace\->call" 4
.el .IP "($pkg, \f(CW$file\fR, \f(CW$line\fR, \f(CW$subname\fR) = \f(CW$trace\fR\->call" 4
.IX Item "($pkg, $file, $line, $subname) = $trace->call"
Get the basic call info as a list.
.ie n .IP "@caller = $trace\->full_call" 4
.el .IP "\f(CW@caller\fR = \f(CW$trace\fR\->full_call" 4
.IX Item "@caller = $trace->full_call"
Get the full caller(N) results.
.ie n .IP "$warning_bits = $trace\->warning_bits" 4
.el .IP "\f(CW$warning_bits\fR = \f(CW$trace\fR\->warning_bits" 4
.IX Item "$warning_bits = $trace->warning_bits"
Get index 9 from the full caller info. This is the warnings_bits field.
.Sp
The value of this is not portable across perl versions or even processes.
However it can be used in the process that generated it to reproduce the
warnings settings in a new scope.
.Sp
.Vb 4
\&    eval <<EOT;
\&    BEGIN { ${^WARNING_BITS} = $trace\->warning_bits };
\&    ... context\*(Aqs warning settings apply here ...
\&    EOT
.Ve
.SS "\s-1DISCOURAGED HUB RELATED FIELDS\s0"
.IX Subsection "DISCOURAGED HUB RELATED FIELDS"
These fields were not always set properly by tools. These are \fB\s-1MOSTLY\s0\fR
deprecated by the Test2::EventFacet::Hub facets. These fields are not
required, and may only reflect the hub that was current when the event was
created, which is not necessarily the same as the hub the event was sent
through.
.PP
Some tools did do a good job setting these to the correct hub, but you cannot
always rely on that. Use the 'hubs' facet list instead.
.ie n .IP "$hid = $trace\->{hid}" 4
.el .IP "\f(CW$hid\fR = \f(CW$trace\fR\->{hid}" 4
.IX Item "$hid = $trace->{hid}"
.PD 0
.ie n .IP "$hid = $trace\->\fIhid()\fR" 4
.el .IP "\f(CW$hid\fR = \f(CW$trace\fR\->\fIhid()\fR" 4
.IX Item "$hid = $trace->hid()"
.PD
The \s-1ID\s0 of the hub that was current when the event was created.
.ie n .IP "$huuid = $trace\->{huuid}" 4
.el .IP "\f(CW$huuid\fR = \f(CW$trace\fR\->{huuid}" 4
.IX Item "$huuid = $trace->{huuid}"
.PD 0
.ie n .IP "$huuid = $trace\->\fIhuuid()\fR" 4
.el .IP "\f(CW$huuid\fR = \f(CW$trace\fR\->\fIhuuid()\fR" 4
.IX Item "$huuid = $trace->huuid()"
.PD
The \s-1UUID\s0 of the hub that was current when the event was created. (If uuid
tagging was enabled).
.ie n .IP "$int = $trace\->{nested}" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->{nested}" 4
.IX Item "$int = $trace->{nested}"
.PD 0
.ie n .IP "$int = $trace\->\fInested()\fR" 4
.el .IP "\f(CW$int\fR = \f(CW$trace\fR\->\fInested()\fR" 4
.IX Item "$int = $trace->nested()"
.PD
How deeply nested the event is.
.ie n .IP "$bool = $trace\->{buffered}" 4
.el .IP "\f(CW$bool\fR = \f(CW$trace\fR\->{buffered}" 4
.IX Item "$bool = $trace->{buffered}"
.PD 0
.ie n .IP "$bool = $trace\->\fIbuffered()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$trace\fR\->\fIbuffered()\fR" 4
.IX Item "$bool = $trace->buffered()"
.PD
True if the event was buffered and not sent to the formatter independent of a
parent (This should never be set when nested is \f(CW0\fR or \f(CW\*(C`undef\*(C'\fR).
.SH "METHODS"
.IX Header "METHODS"
\&\fBNote:\fR All facet frames are also methods.
.ie n .IP "$trace\->set_detail($msg)" 4
.el .IP "\f(CW$trace\fR\->set_detail($msg)" 4
.IX Item "$trace->set_detail($msg)"
.PD 0
.ie n .IP "$msg = $trace\->detail" 4
.el .IP "\f(CW$msg\fR = \f(CW$trace\fR\->detail" 4
.IX Item "$msg = $trace->detail"
.PD
Used to get/set a custom trace message that will be used \s-1INSTEAD\s0 of
\&\f(CW\*(C`at <FILE> line <LINE>\*(C'\fR when calling \f(CW\*(C`$trace\->debug\*(C'\fR.
.Sp
\&\f(CW\*(C`detail()\*(C'\fR is an alias to the \f(CW\*(C`details\*(C'\fR facet field for backwards
compatibility.
.ie n .IP "$str = $trace\->debug" 4
.el .IP "\f(CW$str\fR = \f(CW$trace\fR\->debug" 4
.IX Item "$str = $trace->debug"
Typically returns the string \f(CW\*(C`at <FILE> line <LINE>\*(C'\fR. If \f(CW\*(C`detail\*(C'\fR is set
then its value will be returned instead.
.ie n .IP "$trace\->alert($MESSAGE)" 4
.el .IP "\f(CW$trace\fR\->alert($MESSAGE)" 4
.IX Item "$trace->alert($MESSAGE)"
This issues a warning at the frame (filename and line number where
errors should be reported).
.ie n .IP "$trace\->throw($MESSAGE)" 4
.el .IP "\f(CW$trace\fR\->throw($MESSAGE)" 4
.IX Item "$trace->throw($MESSAGE)"
This throws an exception at the frame (filename and line number where
errors should be reported).
.ie n .IP "($package, $file, $line, $subname) = $trace\->\fIcall()\fR" 4
.el .IP "($package, \f(CW$file\fR, \f(CW$line\fR, \f(CW$subname\fR) = \f(CW$trace\fR\->\fIcall()\fR" 4
.IX Item "($package, $file, $line, $subname) = $trace->call()"
Get the caller details for the debug-info. This is where errors should be
reported.
.ie n .IP "$pkg = $trace\->package" 4
.el .IP "\f(CW$pkg\fR = \f(CW$trace\fR\->package" 4
.IX Item "$pkg = $trace->package"
Get the debug-info package.
.ie n .IP "$file = $trace\->file" 4
.el .IP "\f(CW$file\fR = \f(CW$trace\fR\->file" 4
.IX Item "$file = $trace->file"
Get the debug-info filename.
.ie n .IP "$line = $trace\->line" 4
.el .IP "\f(CW$line\fR = \f(CW$trace\fR\->line" 4
.IX Item "$line = $trace->line"
Get the debug-info line number.
.ie n .IP "$subname = $trace\->subname" 4
.el .IP "\f(CW$subname\fR = \f(CW$trace\fR\->subname" 4
.IX Item "$subname = $trace->subname"
Get the debug-info subroutine name.
.ie n .IP "$sig = trace\->signature" 4
.el .IP "\f(CW$sig\fR = trace\->signature" 4
.IX Item "$sig = trace->signature"
Get a signature string that identifies this trace. This is used to check if
multiple events are related. The signature includes pid, tid, file, line
number, and the cid.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2020 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR