Test2::IPC::Driver(3p) Perl Programmers Reference Guide #

Test2::IPC::Driver(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Test2::IPC::Driver - Base class for Test2 IPC drivers.

SSYYNNOOPPSSIISS #

     package Test2::IPC::Driver::MyDriver;

     use base 'Test2::IPC::Driver';

     ...

MMEETTHHOODDSS #

 $self->abort($msg)
     If an IPC encounters a fatal error it should use this. This will
     print the message to STDERR with 'IPC Fatal Error: ' prefixed to it,
     then it will forcefully exit 255. IPC errors may occur in threads or
     processes other than the main one, this method provides the best
     chance of the harness noticing the error.

 $self->abort_trace($msg)
     This is the same as "$ipc->abort($msg)" except that it uses
     "Carp::longmess" to add a stack trace to the message.

LLOOAADDIINNGG DDRRIIVVEERRSS #

 Test2::IPC::Driver has an "import()" method. All drivers inherit this
 import method. This import method registers the driver.

 In most cases you just need to load the desired IPC driver to make it
 work. You should load this driver as early as possible. A warning will be
 issued if you load it too late for it to be effective.

     use Test2::IPC::Driver::MyDriver;
     ...

WWRRIITTIINNGG DDRRIIVVEERRSS #

     package Test2::IPC::Driver::MyDriver;
     use strict;
     use warnings;

     use base 'Test2::IPC::Driver';

     sub is_viable {
         return 0 if $^O eq 'win32'; # Will not work on windows.
         return 1;
     }

     sub add_hub {
         my $self = shift;
         my ($hid) = @_;

         ... # Make it possible to contact the hub
     }

     sub drop_hub {
         my $self = shift;
         my ($hid) = @_;

         ... # Nothing should try to reach the hub anymore.
     }

     sub send {
         my $self = shift;
         my ($hid, $e, $global) = @_;

         ... # Send the event to the proper hub.

         # This may notify other procs/threads that there is a pending event.
         Test2::API::test2_ipc_set_pending($uniq_val);
     }

     sub cull {
         my $self = shift;
         my ($hid) = @_;

         my @events = ...; # Here is where you get the events for the hub

         return @events;
     }

     sub waiting {
         my $self = shift;

         ... # Notify all listening procs and threads that the main
         ... # process/thread is waiting for them to finish.
     }

     1;

MMEETTHHOODDSS SSUUBBCCLLAASSSSEESS MMUUSSTT IIMMPPLLEEMMEENNTT #

 $ipc->is_viable
     This should return true if the driver works in the current
     environment. This should return false if it does not. This is a CLASS
     method.

 $ipc->add_hub($hid)
     This is used to alert the driver that a new hub is expecting events.
     The driver should keep track of the process and thread ids, the hub
     should only be dropped by the proc+thread that started it.

         sub add_hub {
             my $self = shift;
             my ($hid) = @_;

             ... # Make it possible to contact the hub
         }

 $ipc->drop_hub($hid)
     This is used to alert the driver that a hub is no longer accepting
     events. The driver should keep track of the process and thread ids,
     the hub should only be dropped by the proc+thread that started it
     (This is the drivers responsibility to enforce).

         sub drop_hub {
             my $self = shift;
             my ($hid) = @_;

             ... # Nothing should try to reach the hub anymore.
         }

 $ipc->send($hid, $event);
 $ipc->send($hid, $event, $global);
     Used to send events from the current process/thread to the specified
     hub in its process+thread.

         sub send {
             my $self = shift;
             my ($hid, $e) = @_;

             ... # Send the event to the proper hub.

             # This may notify other procs/threads that there is a pending event.
             Test2::API::test2_ipc_set_pending($uniq_val);
         }

     If $global is true then the driver should send the event to all hubs
     in all processes and threads.

 @events = $ipc->cull($hid)
     Used to collect events that have been sent to the specified hub.

         sub cull {
             my $self = shift;
             my ($hid) = @_;

             my @events = ...; # Here is where you get the events for the hub

             return @events;
         }

 $ipc->wwaaiittiinngg(())
     This is called in the parent process when it is complete and waiting
     for all child processes and threads to complete.

         sub waiting {
             my $self = shift;

             ... # Notify all listening procs and threads that the main
             ... # process/thread is waiting for them to finish.
         }

MMEETTHHOODDSS SSUUBBCCLLAASSSSEESS MMAAYY IIMMPPLLEEMMEENNTT OORR OOVVEERRRRIIDDEE #

 $ipc->driver_abort($msg)
     This is a hook called by "Test2::IPC::Driver->abort()". This is your
     chance to cleanup when an abort happens. You cannot prevent the
     abort, but you can gracefully except it.

SSOOUURRCCEE #

 The source code repository for Test2 can be found at
 _h_t_t_p_:_/_/_g_i_t_h_u_b_._c_o_m_/_T_e_s_t_-_M_o_r_e_/_t_e_s_t_-_m_o_r_e_/.

MMAAIINNTTAAIINNEERRSS #

 Chad Granum <exodist@cpan.org>

AAUUTTHHOORRSS #

 Chad Granum <exodist@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2020 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 _h_t_t_p_:_/_/_d_e_v_._p_e_r_l_._o_r_g_/_l_i_c_e_n_s_e_s_/

perl v5.36.3 2023-02-15 Test2::IPC::Driver(3p)