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