Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Manual::Anatomy::IPC.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Manual::Anatomy::IPC 3pm"
61 .TH Test2::Manual::Anatomy::IPC 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Manual::Anatomy::IPC \- Manual for the IPC system.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This document describes the IPC system.
71 .SH "WHAT IS THE IPC SYSTEM"
72 .IX Header "WHAT IS THE IPC SYSTEM"
73 The IPC system is activated by loading Test2::IPC. This makes hubs
74 process/thread aware, and makes them forward events along to the parent
75 process/thread as necessary.
76 .SH "HOW DOES THE IPC SYSTEM AFFECT EVERYTHING?"
77 .IX Header "HOW DOES THE IPC SYSTEM AFFECT EVERYTHING?"
78 Test2::API and Test2::API::Instance have some behaviors that trigger if
79 Test2::IPC is loaded before the global state is initialized. Mainly an IPC
80 driver will be initiated and stored in the global state.
81 .PP
82 If an IPC driver is initialized then all hubs will be initialized with a
83 reference to the driver instance. If a hub has an IPC driver instance it will
84 use it to forward events to parent processes and threads.
85 .SH "WHAT DOES AN IPC DRIVER DO?"
86 .IX Header "WHAT DOES AN IPC DRIVER DO?"
87 An Test2::IPC::Driver provides a way to send event data to a destination
88 process+thread+hub (or to all globally). The driver must also provide a way for
89 a process/thread/hub to read in any pending events that have been sent to it.
90 .SH "HOW DOES THE DEFAULT IPC DRIVER WORK?"
91 .IX Header "HOW DOES THE DEFAULT IPC DRIVER WORK?"
92 The default IPC driver is Test2::IPC::Driver::Files. This default driver,
93 when initialized, starts by creating a temporary directory. Any time an event
94 needs to be sent to another process/thread/hub, the event will be written to a
95 file using Storable. The file is written with the destination process,
96 thread, and hub as part of the filename. All hubs will regularly check for
97 pending IPC events and will process them.
98 .PP
99 This driver is further optimized using a small chunk of SHM. Any time a new
100 event is sent via IPC the shm is updated to have a new value. Hubs will not
101 bother checking for new IPC events unless the shm value has changed since their
102 last poll. A result of this is that the IPC system is surprisingly fast, and
103 does not waste time polling the hard drive when there are no pending events.
104 .SH "SEE ALSO"
105 .IX Header "SEE ALSO"
106 Test2::Manual \- Primary index of the manual.
107 .SH SOURCE
108 .IX Header "SOURCE"
109 The source code repository for Test2\-Manual can be found at
110 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
111 .SH MAINTAINERS
112 .IX Header "MAINTAINERS"
113 .IP "Chad Granum <[email protected]>" 4
114 .IX Item "Chad Granum <[email protected]>"
115 .SH AUTHORS
116 .IX Header "AUTHORS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright Chad Granum <[email protected]>.
122 .PP
123 This program is free software; you can redistribute it and/or
124 modify it under the same terms as Perl itself.
125 .PP
126 See \fIhttp://dev.perl.org/licenses/\fR