]> git.vpit.fr Git - perl/modules/Bit-MorseSignals.git/blobdiff - lib/Bit/MorseSignals.pm
Put each POD sentence on its own line
[perl/modules/Bit-MorseSignals.git] / lib / Bit / MorseSignals.pm
index 4df153d8ff3f2cbdc7b5d85f518b7bb3b9e8dbd1..bd16e84bf1ca9ac19d24e277757e79c1058bc7bf 100644 (file)
@@ -30,7 +30,9 @@ our $VERSION = '0.08';
 
 =head1 DESCRIPTION
 
-In unidirectionnal communication channels (such as networking or IPC), the main issue is often to know the length of the message. Some possible solutions are fixed-length messages (which is quite cumbersome) or a special ending sequence (but it no longer can appear in the data). This module proposes another solution, by using a begin/end signature specialized for each message.
+In unidirectionnal communication channels (such as networking or IPC), the main issue is often to know the length of the message.
+Some possible solutions are fixed-length messages (which is quite cumbersome) or a special ending sequence (but it no longer can appear in the data).
+This module proposes another solution, by using a begin/end signature specialized for each message.
 
 An actual implementation is also provided :
 
@@ -50,7 +52,8 @@ Go to those pages if you just want the stuff done and don't care about how it ge
 
 =head1 PROTOCOL
 
-Each byte of the data string is converted into its bits sequence, with bits of lowest weight coming first. All those bits sequences are put into the same order as the characters occur in the string.
+Each byte of the data string is converted into its bits sequence, with bits of lowest weight coming first.
+All those bits sequences are put into the same order as the characters occur in the string.
 
 The header is composed of three bits (lowest weight coming first) :
 
@@ -58,15 +61,18 @@ The header is composed of three bits (lowest weight coming first) :
 
 =item *
 
-The 2 first ones denote the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object. See also the L</CONSTANTS> section ;
+The 2 first ones denote the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object.
+See also the L</CONSTANTS> section ;
 
 =item *
 
-The third one is reserved. For compatibility reasons, the receiver should for now enforce the message data type to plain when this bit is lit.
+The third one is reserved.
+For compatibility reasons, the receiver should for now enforce the message data type to plain when this bit is lit.
 
 =back
 
-The emitter computes then the longuest sequence of successives 0 (say, m) and 1 (n) in the concatenation of the header and the data. A signature is then chosen :
+The emitter computes then the longuest sequence of successives 0 (say, m) and 1 (n) in the concatenation of the header and the data.
+A signature is then chosen :
 
 =over 4
 
@@ -85,7 +91,8 @@ The signal is then formed by concatenating the signature, the header, the data b
     a ... a b | t0 t1 r | ... data ... | b a ... a
     signature | header  |     data     | reversed signature
 
-The receiver knows that the signature has been sent when it has catched at least one 0 and one 1. The signal is completely transferred when it has received for the first time the whole reversed signature.
+The receiver knows that the signature has been sent when it has catched at least one 0 and one 1.
+The signal is completely transferred when it has received for the first time the whole reversed signature.
 
 =head1 CONSTANTS
 
@@ -100,15 +107,18 @@ use constant {
 
 =head2 C<BM_DATA_AUTO>
 
-Default for non-references messages. Try to guess if the given scalar is an UTF-8 string with C<Encode::is_utf8>.
+Default for non-references messages.
+Try to guess if the given scalar is an UTF-8 string with C<Encode::is_utf8>.
 
 =head2 C<BM_DATA_PLAIN>
 
-Treats the data as a plain string. No extra mangling in done.
+Treats the data as a plain string.
+No extra mangling in done.
 
 =head2 C<BM_DATA_UTF8>
 
-Treats the data as an UTF-8 string. The string is C<Encode::encode_utf8>'d in a binary string before sending, and C<Encode::decode_utf8>'d by the receiver.
+Treats the data as an UTF-8 string.
+The string is C<Encode::encode_utf8>'d in a binary string before sending, and C<Encode::decode_utf8>'d by the receiver.
 
 =head2 C<BM_DATA_STORABLE>
 
@@ -145,7 +155,8 @@ You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-bit-morsesignals at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bit-MorseSignals>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-bit-morsesignals at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bit-MorseSignals>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT