lib/Bit/MorseSignals.pm

   1 package Bit::MorseSignals;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Bit::MorseSignals - The MorseSignals protocol.
   9
  10 =head1 VERSION
  11
  12 Version 0.01
  13
  14 =cut
  15
  16 our $VERSION = '0.01';
  17
  18 =head1 DESCRIPTION
  19
  20 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.
  21
  22 An actual implementation is also provided :
  23
  24 =over 4
  25
  26 =item L<Bit::MorseSignals::Emitter> is a base class for emitters ;
  27
  28 =item L<Bit::MorseSignals::Receiver> is a base class for receivers ;
  29
  30 =back
  31
  32 Go to those pages if you just want the stuff done and don't care about how it gets there.
  33
  34 =head1 PROTOCOL
  35
  36 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.
  37
  38 The header is composed of three bits (lowest weight coming first) :
  39
  40 =over 4
  41
  42 =item - The 2 first ones denotes 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> sections ;
  43
  44 =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.
  45
  46 =back
  47
  48 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 :
  49
  50 =over 4
  51
  52 =item - If m > n, we take n+1 times 1 followed by one 0 ;
  53
  54 =item - Otherwise, we take m+1 times 0 followed by one 1.
  55
  56 =back
  57
  58 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 in the reverse order).
  59
  60     a ... a b | t0 t1 r | ... data ... | b a ... a
  61     signature | header  |     data     | reversed signature
  62
  63 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.
  64
  65 =head1 CONSTANTS
  66
  67 =cut
  68
  69 use constant {
  70  BM_DATA_AUTO     => -1,
  71  BM_DATA_PLAIN    => 0,
  72  BM_DATA_UTF8     => 1,
  73  BM_DATA_STORABLE => 2,
  74 };
  75
  76 =head2 C<BM_DATA_AUTO>
  77
  78 Default for non-references messages. Try to guess if the given scalar is an UTF-8 string with C<Encode::is_utf8>.
  79
  80 =head2 C<BM_DATA_PLAIN>
  81
  82 Treats the data as a plain string. No extra mangling in done.
  83
  84 =head2 C<BM_DATA_UTF8>
  85
  86 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.
  87
  88 =head2 C<BM_DATA_STORABLE>
  89
  90 The scalar, array or hash reference given is C<Storable::freeze>'d by the sender and C<Storable::thaw>'d by the receiver.
  91
  92 =head1 EXPORT
  93
  94 The constants L</BM_DATA_AUTO>, L</BM_DATA_PLAIN>, L</BM_DATA_UTF8> and L</BM_DATA_STORABLE> are only exported on request, either by specifying their names or the C<':consts'> tag.
  95
  96 =cut
  97
  98 use base qw/Exporter/;
  99
 100 our @EXPORT         = ();
 101 our %EXPORT_TAGS    = (
 102  'consts' => [ qw/BM_DATA_AUTO BM_DATA_PLAIN BM_DATA_UTF8 BM_DATA_STORABLE/ ]
 103 );
 104 our @EXPORT_OK      = map { @$_ } values %EXPORT_TAGS;
 105 $EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
 106
 107 =head1 DEPENDENCIES
 108
 109 L<Carp> (standard since perl 5), L<Encode> (since perl 5.007003), L<Storable> (idem).
 110
 111 =head1 SEE ALSO
 112
 113 L<Bit::MorseSignals::Emitter>, L<Bit::MorseSignals::Receiver>.
 114
 115 =head1 AUTHOR
 116
 117 Vincent Pit, C<< <perl at profvince.com> >>
 118
 119 You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).
 120
 121 =head1 BUGS
 122
 123 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.
 124
 125 =head1 SUPPORT
 126
 127 You can find documentation for this module with the perldoc command.
 128
 129     perldoc Bit::MorseSignals
 130
 131 =head1 COPYRIGHT & LICENSE
 132
 133 Copyright 2008 Vincent Pit, all rights reserved.
 134
 135 This program is free software; you can redistribute it and/or modify it
 136 under the same terms as Perl itself.
 137
 138 =cut
 139
 140 1; # End of Bit::MorseSignals