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