cpan/Test-Simple/lib/Test2/EventFacet/Hub.pm

   1 package Test2::EventFacet::Hub;
   2 use strict;
   3 use warnings;
   4
   5 our $VERSION = '1.302181';
   6
   7 sub is_list { 1 }
   8 sub facet_key { 'hubs' }
   9
  10 BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
  11 use Test2::Util::HashBase qw{-pid -tid -hid -nested -buffered -uuid -ipc};
  12
  13 1;
  14
  15 __END__
  16
  17 =pod
  18
  19 =encoding UTF-8
  20
  21 =head1 NAME
  22
  23 Test2::EventFacet::Hub - Facet for the hubs an event passes through.
  24
  25 =head1 DESCRIPTION
  26
  27 These are a record of the hubs an event passes through. Most recent hub is the
  28 first one in the list.
  29
  30 =head1 FACET FIELDS
  31
  32 =over 4
  33
  34 =item $string = $trace->{details}
  35
  36 =item $string = $trace->details()
  37
  38 The hub class or subclass
  39
  40 =item $int = $trace->{pid}
  41
  42 =item $int = $trace->pid()
  43
  44 PID of the hub this event was sent to.
  45
  46 =item $int = $trace->{tid}
  47
  48 =item $int = $trace->tid()
  49
  50 The thread ID of the hub the event was sent to.
  51
  52 =item $hid = $trace->{hid}
  53
  54 =item $hid = $trace->hid()
  55
  56 The ID of the hub that the event was send to.
  57
  58 =item $huuid = $trace->{huuid}
  59
  60 =item $huuid = $trace->huuid()
  61
  62 The UUID of the hub that the event was sent to.
  63
  64 =item $int = $trace->{nested}
  65
  66 =item $int = $trace->nested()
  67
  68 How deeply nested the hub was.
  69
  70 =item $bool = $trace->{buffered}
  71
  72 =item $bool = $trace->buffered()
  73
  74 True if the event was buffered and not sent to the formatter independent of a
  75 parent (This should never be set when nested is C<0> or C<undef>).
  76
  77 =back
  78
  79 =head1 SOURCE
  80
  81 The source code repository for Test2 can be found at
  82 F<http://github.com/Test-More/test-more/>.
  83
  84 =head1 MAINTAINERS
  85
  86 =over 4
  87
  88 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  89
  90 =back
  91
  92 =head1 AUTHORS
  93
  94 =over 4
  95
  96 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  97
  98 =back
  99
 100 =head1 COPYRIGHT
 101
 102 Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
 103
 104 This program is free software; you can redistribute it and/or
 105 modify it under the same terms as Perl itself.
 106
 107 See F<http://dev.perl.org/licenses/>
 108
 109 =cut