Importing IPC-MorseSignals-0.09.tar.gz

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

diff --git a/README b/README
index 098eddf457353ae2aa83e48538170180019c97c6..c445bc87568cb497dc160b57971bcd5ed202ae6c 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     IPC::MorseSignals - Communicate between processes with Morse signals.
 
 VERSION
     IPC::MorseSignals - Communicate between processes with Morse signals.
 
 VERSION

-    Version 0.06
+    Version 0.09

 
 SYNOPSIS
         use IPC::MorseSignals qw/msend mrecv/;
 
 SYNOPSIS
         use IPC::MorseSignals qw/msend mrecv/;


@@ -29,16 +29,15 @@ DESCRIPTION
 
 FUNCTIONS
   "msend"
 
 FUNCTIONS
   "msend"

-        msend $msg, $pid [, speed => $speed, utf8 => $utf8, sign => $sign ]
+        msend $msg, $pid [, speed => $speed, sign => $sign ]

 
     Sends the string $msg to the process $pid (or to all the processes @$pid
     if $pid is an array ref) at $speed bits per second. Default speed is
     512, don't set it too low or the target will miss bits and the whole
 
     Sends the string $msg to the process $pid (or to all the processes @$pid
     if $pid is an array ref) at $speed bits per second. Default speed is
     512, don't set it too low or the target will miss bits and the whole

-    message will be crippled. If the "utf8" flag is set (default is unset),
-    the string will first be encoded in UTF-8. The "utf8" bit of the packet
-    message is turned on, so that the receiver is aware of it. If the "sign"
-    flag is unset (default is set), the PID of the sender won't be shipped
-    with the packet.
+    message will be crippled. If the "sign" flag is unset (default is set),
+    the PID of the sender won't be shipped with the packet. UTF-8 encoded
+    strings are automatically detected. The "utf8" bit of the packet message
+    is turned on, so that the receiver can encode them appropriately.

 
   "mrecv"
         mrecv %SIG [, cb => $callback ]
 
   "mrecv"
         mrecv %SIG [, cb => $callback ]


@@ -49,7 +48,7 @@ FUNCTIONS
     the callback to trigger each time a complete message has arrived.
     Basically, you want to use it like this :
 
     the callback to trigger each time a complete message has arrived.
     Basically, you want to use it like this :
 

-        my $rv = mrecv local %SIG, cb => sub { ... };
+        my $rcv = mrecv local %SIG, cb => sub { ... };

 
     In the callback, $_[0] is the sender's PID (or 0 if the sender wanted to
     stay anonymous) and $_[1] is the message received.
 
     In the callback, $_[0] is the sender's PID (or 0 if the sender wanted to
     stay anonymous) and $_[1] is the message received.


@@ -66,7 +65,7 @@ FUNCTIONS
     or false otherwise.
 
   "mlastsender"
     or false otherwise.
 
   "mlastsender"

-        mlastmsg $rcv
+        mlastsender $rcv

 
     Holds the PID of the last process that sent data to the receiver $rcv, 0
     if that process was anonymous, or "undef" if no message has arrived yet.
 
     Holds the PID of the last process that sent data to the receiver $rcv, 0
     if that process was anonymous, or "undef" if no message has arrived yet.


@@ -95,8 +94,8 @@ PROTOCOL
     m) and 1 (n) in the concatenation of the header and the data. A
     signature is then chosen :
 
     m) and 1 (n) in the concatenation of the header and the data. A
     signature is then chosen :
 

-    - If m > n, we take n+1 times 1 follewed by one 0 ;
-    - Otherwise, we take m+1 times 0 follewed by one 1.
+    - If m > n, we take n+1 times 1 followed by one 0 ;
+    - Otherwise, we take m+1 times 0 followed by one 1.

 
     The signal is then formed by concatenating the signature, the header,
     the data bits and the reversed signature (i.e. the bits of the signature
 
     The signal is then formed by concatenating the signature, the header,
     the data bits and the reversed signature (i.e. the bits of the signature


@@ -117,8 +116,8 @@ CAVEATS
     transfer data to a sleeping process.
 
 DEPENDENCIES
     transfer data to a sleeping process.
 
 DEPENDENCIES

-    Carp (standard since perl 5), POSIX (idem), Time::HiRes (since perl
-    5.7.3) and utf8 (since perl 5.6) are required.
+    Carp (standard since perl 5), POSIX (idem), utf8 (since perl 5.6),
+    Encode (since perl 5.7.3) and Time::HiRes (idem) are required.

 
 SEE ALSO
     perlipc for information about signals in perl.
 
 SEE ALSO
     perlipc for information about signals in perl.