Update VPIT::TestHelpers to 15e8aee3

[perl/modules/IPC-MorseSignals.git] / README

diff --git a/README b/README
index aa1abb930a0639d08eb37171786e77d78d1ae558..01bb860f1731e3ebe02bc135f34ddffde2fa8a2e 100644 (file)
--- a/README
+++ b/README
@@ -2,13 +2,19 @@ NAME
     IPC::MorseSignals - Communicate between processes with Morse signals.
 
 VERSION
-    Version 0.10
+    Version 0.17
+
+WARNING
+    Due to the POSIX signals specification (which I wasn't aware of at the
+    time I wrote this module), this module is by nature completely
+    unreliable and will never work properly. It is therefore deprecated.
+    Please don't use it (if you were actually crazy enough to use it).
 
 SYNOPSIS
         # In the sender process
         use IPC::MorseSignals::Emitter;
 
-        my $deuce = new IPC::MorseSignals::Emitter speed => 1024;
+        my $deuce = IPC::MorseSignals::Emitter->new(speed => 1024);
         $deuce->post('HLAGH') for 1 .. 3;
         $deuce->send($pid);
 
@@ -18,21 +24,28 @@ SYNOPSIS
         use IPC::MorseSignals::Receiver;
 
         local %SIG;
-        my $pants = new IPC::MorseSignals::Receiver \%SIG, done => sub {
+        my $pants = IPC::MorseSignals::Receiver->new(\%SIG, done => sub {
          print STDERR "GOT $_[1]\n";
-        };
-
-    head1 DESCRIPTION
+        });
 
+DESCRIPTION
     This module implements a rare form of IPC by sending Morse-like signals
     through "SIGUSR1" and "SIGUSR2". Both of those signals are used, so you
     won't be able to keep them for something else when you use this module.
 
-    IPC::MorseSignals::Emitter is a base class for emitters ;
-    IPC::MorseSignals::Receiver is a base class for receivers ;
+    *   IPC::MorseSignals::Emitter is a base class for emitters ;
+
+    *   IPC::MorseSignals::Receiver is a base class for receivers.
 
     But, seriously, use something else for your IPC. :)
 
+CAVEATS
+    When the same signal is sent several times in a row to a process, the
+    POSIX standard does not guarantee that the relevant signal handler will
+    be called for each of the notifications. This will result in malformed
+    messages if the transfer speed is so high that the operating system does
+    not have the time to call the signal handler for each bit.
+
 DEPENDENCIES
     You need the complete Bit::MorseSignals distribution.
 
@@ -52,8 +65,7 @@ SEE ALSO
 AUTHOR
     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
 
-    You can contact me by mail or on #perl @ FreeNode (vincent or
-    Prof_Vince).
+    You can contact me by mail or on "irc.perl.org" (vincent).
 
 BUGS
     Please report any bugs or feature requests to "bug-ipc-morsesignals at
@@ -72,7 +84,7 @@ ACKNOWLEDGEMENTS
     your IPC needs. :)
 
 COPYRIGHT & LICENSE
-    Copyright 2007-2008 Vincent Pit, all rights reserved.
+    Copyright 2007,2008,2013,2017 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.