]> git.vpit.fr Git - perl/modules/IPC-MorseSignals.git/blob - README
Update VPIT::TestHelpers to 15e8aee3
[perl/modules/IPC-MorseSignals.git] / README
1 NAME
2     IPC::MorseSignals - Communicate between processes with Morse signals.
3
4 VERSION
5     Version 0.17
6
7 WARNING
8     Due to the POSIX signals specification (which I wasn't aware of at the
9     time I wrote this module), this module is by nature completely
10     unreliable and will never work properly. It is therefore deprecated.
11     Please don't use it (if you were actually crazy enough to use it).
12
13 SYNOPSIS
14         # In the sender process
15         use IPC::MorseSignals::Emitter;
16
17         my $deuce = IPC::MorseSignals::Emitter->new(speed => 1024);
18         $deuce->post('HLAGH') for 1 .. 3;
19         $deuce->send($pid);
20
21         ...
22
23         # In the receiver process
24         use IPC::MorseSignals::Receiver;
25
26         local %SIG;
27         my $pants = IPC::MorseSignals::Receiver->new(\%SIG, done => sub {
28          print STDERR "GOT $_[1]\n";
29         });
30
31 DESCRIPTION
32     This module implements a rare form of IPC by sending Morse-like signals
33     through "SIGUSR1" and "SIGUSR2". Both of those signals are used, so you
34     won't be able to keep them for something else when you use this module.
35
36     *   IPC::MorseSignals::Emitter is a base class for emitters ;
37
38     *   IPC::MorseSignals::Receiver is a base class for receivers.
39
40     But, seriously, use something else for your IPC. :)
41
42 CAVEATS
43     When the same signal is sent several times in a row to a process, the
44     POSIX standard does not guarantee that the relevant signal handler will
45     be called for each of the notifications. This will result in malformed
46     messages if the transfer speed is so high that the operating system does
47     not have the time to call the signal handler for each bit.
48
49 DEPENDENCIES
50     You need the complete Bit::MorseSignals distribution.
51
52     Carp (standard since perl 5), POSIX (idem) and Time::HiRes (since perl
53     5.7.3) are also required.
54
55 SEE ALSO
56     IPC::MorseSignals::Emitter, IPC::MorseSignals::Receiver.
57
58     Bit::MorseSignals, Bit::MorseSignals::Emitter,
59     Bit::MorseSignals::Receiver.
60
61     perlipc for information about signals in perl.
62
63     For truly useful IPC, search for shared memory, pipes and semaphores.
64
65 AUTHOR
66     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
67
68     You can contact me by mail or on "irc.perl.org" (vincent).
69
70 BUGS
71     Please report any bugs or feature requests to "bug-ipc-morsesignals at
72     rt.cpan.org", or through the web interface at
73     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IPC-MorseSignals>. I
74     will be notified, and then you'll automatically be notified of progress
75     on your bug as I make changes.
76
77 SUPPORT
78     You can find documentation for this module with the perldoc command.
79
80         perldoc IPC::MorseSignals
81
82 ACKNOWLEDGEMENTS
83     Thanks for the inspiration, mofino ! I hope this module will fill all
84     your IPC needs. :)
85
86 COPYRIGHT & LICENSE
87     Copyright 2007,2008,2013,2017 Vincent Pit, all rights reserved.
88
89     This program is free software; you can redistribute it and/or modify it
90     under the same terms as Perl itself.
91