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