Debian Codegraph @

upstream/debian-unstable/man3/Test2::Manual::Anatomy::IPC.3perl

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