Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Test2::EventFacet::Control (3)

Name

Test2::EventFacet::Control - Facet for hub actions and behaviors.

Synopsis

Please see following description for synopsis

Description

Perl Programmers Reference Guide
                                                 Test2::EventFacet::Control(3)



NAME
       Test2::EventFacet::Control - Facet for hub actions and behaviors.

DESCRIPTION
       This facet is used when the event needs to give instructions to the
       Test2 internals.

FIELDS
       $string = $control->{details}
       $string = $control->details()
           Human readable explanation for the special behavior.

       $bool = $control->{global}
       $bool = $control->global()
           True if the event is global in nature and should be seen by all
           hubs.

       $exit = $control->{terminate}
       $exit = $control->terminate()
           Defined if the test should immediately exit, the value is the exit
           code and may be 0.

       $bool = $control->{halt}
       $bool = $control->halt()
           True if all testing should be halted immediately.

       $bool = $control->{has_callback}
       $bool = $control->has_callback()
           True if the "callback($hub)" method on the event should be called.

       $encoding = $control->{encoding}
       $encoding = $control->encoding()
           This can be used to change the encoding from this event onward.

       $phase = $control->{phase}
       $phase = $control->phase()
           Used to signal that a phase change has occurred. Currently only the
           perl END phase is signaled.

SOURCE
       The source code repository for Test2 can be found at
       http://github.com/Test-More/test-more/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2019 Chad Granum <exodist@cpan.org>.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

       See http://dev.perl.org/licenses/



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                                 Test2::EventFacet::Control(3)