lib/Bit/MorseSignals/Receiver.pm

   1 package Bit::MorseSignals::Receiver;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Carp qw/croak/;
   7 use Encode qw/decode_utf8/;
   8 use Storable qw/thaw/;
   9
  10 use Bit::MorseSignals qw/:consts/;
  11
  12 =head1 NAME
  13
  14 Bit::MorseSignals::Receiver - Base class for Bit::MorseSignals receivers.
  15
  16 =head1 VERSION
  17
  18 Version 0.01
  19
  20 =cut
  21
  22 our $VERSION = '0.01';
  23
  24 =head1 SYNOPSIS
  25
  26     use Bit::MorseSignals;
  27
  28     my $pants = new Bit::MorseSignals::Receiver done => sub { print "received $_[1]!\n" };
  29     while (...) {
  30      my $bit = comes_from_somewhere_lets_say_signals();
  31      $pants->push($bit);
  32     }
  33
  34 =head1 DESCRIPTION
  35
  36 Base class for L<Bit::MorseSignals> receivers. Please refer to this module for more general information about the protocol.
  37
  38 Given a sequence of bits coming from the L<Bit::MorseSignals> protocol, the receiver object detects when a packet has been completed and then reconstructs the original message depending of the datatype specified in the header.
  39
  40 =cut
  41
  42 sub _check_self {
  43  croak 'First argument isn\'t a valid ' . __PACKAGE__ . ' object'
  44   unless ref $_[0] and $_[0]->isa(__PACKAGE__);
  45 }
  46
  47 =head1 METHODS
  48
  49 =head2 C<< new [ done => $cb ] >>
  50
  51 L<Bit::MorseSignal::Receiver> object constructor. With the C<'done'> option, you can specify a callback that will be triggered every time a message is completed, and in which C<$_[0]> will be the receiver object and C<$_[1]> the message received.
  52
  53 =cut
  54
  55 sub new {
  56  my $class = shift;
  57  $class = ref $class || $class || return;
  58  croak 'Optional arguments must be passed as key => value pairs' if @_ % 2;
  59  my %opts = @_;
  60  my $self = {
  61   msg    => undef,
  62   done   => $opts{done},
  63  };
  64  bless $self, $class;
  65  $self->reset;
  66  return $self;
  67 }
  68
  69 =head2 C<push $bit>
  70
  71 Tells the receiver that you have received the bit C<$bit>. Returns true while the message isn't completed, and C<undef> as soon as it is.
  72
  73 =cut
  74
  75 sub push {
  76  my ($self, $bit) = @_;
  77  _check_self($self);
  78  if (!defined $bit) {
  79   $bit = $_;
  80   return unless defined $bit;
  81  }
  82  $bit = $bit ? 1 : 0;
  83
  84  if ($self->{state} == 3) { # data
  85
  86   vec($self->{buf}, $self->{len}, 1) = $bit;
  87   ++$self->{len};
  88   if ($self->{len} >= $self->{sig_len}) {
  89    my $res = 1;
  90    for (1 .. $self->{sig_len}) {
  91     if (vec($self->{buf}, $self->{len} - $_, 1) != vec($self->{sig}, $_-1, 1)) {
  92      $res = 0;
  93      last;
  94     }
  95    }
  96    if ($res) {
  97     my $base = int $self->{sig_len} / 8 + $self->{sig_len} % 8 != 0;
  98     substr $self->{buf}, -$base, $base, '';
  99     my @demanglers = (sub { $_[0] }, \&decode_utf8, \&thaw  );
 100     #        BM_DATA_{PLAIN,         UTF8,          STORABLE}
 101     $self->{msg} = $demanglers[$self->{type}]->($self->{buf});
 102     $self->reset;
 103     $self->{done}->($self, $self->{msg}) if $self->{done};
 104     return;
 105    }
 106   }
 107
 108  } elsif ($self->{state} == 2) { # header
 109
 110   vec($self->{buf}, $self->{len}++, 1) = $bit;
 111   if ($self->{len} >= 3) {
 112    my $type = 2 * vec($self->{buf}, 0, 1)
 113                 + vec($self->{buf}, 1, 1);
 114    @{$self}{qw/state type buf len/} = (3, $type, '', 0);
 115   }
 116
 117  } elsif ($self->{state} == 1) { # end of signature
 118
 119   if ($self->{sig_bit} != $bit) {
 120    $self->{state} = 2;
 121   }
 122   vec($self->{sig}, $self->{sig_len}++, 1) = $bit;
 123
 124  } else { # first bit
 125
 126   @{$self}{qw/state sig sig_bit sig_len buf len/}
 127            = (1,    '', $bit,   1,      '', 0  );
 128   vec($self->{sig}, 0, 1) = $bit;
 129
 130  }
 131
 132  return $self;
 133 }
 134
 135 =head2 C<reset>
 136
 137 Resets the current receiver state, obliterating any current message being received.
 138
 139 =cut
 140
 141 sub reset {
 142  my ($self) = @_;
 143  _check_self($self);
 144  $self->{state} = 0;
 145  @{$self}{qw/sig sig_bit sig_len type buf len/} = ();
 146  return $self;
 147 }
 148
 149 =head2 C<busy>
 150
 151 True when the receiver is in the middle of assembling a message.
 152
 153 =cut
 154
 155 sub busy {
 156  my ($self) = @_;
 157  _check_self($self);
 158  return $self->{state} > 0;
 159 }
 160
 161 =head2 C<msg>
 162
 163 The last message completed, or C<undef> when no message has been assembled yet.
 164
 165 =cut
 166
 167 sub msg {
 168  my ($self) = @_;
 169  _check_self($self);
 170  return $self->{msg};
 171 }
 172
 173 =head1 EXPORT
 174
 175 An object module shouldn't export any function, and so does this one.
 176
 177 =head1 DEPENDENCIES
 178
 179 L<Carp> (standard since perl 5), L<Encode> (since perl 5.007003), L<Storable> (idem).
 180
 181 =head1 SEE ALSO
 182
 183 L<Bit::MorseSignals>, L<Bit::MorseSignals::Emitter>.
 184
 185 =head1 AUTHOR
 186
 187 Vincent Pit, C<< <perl at profvince.com> >>
 188
 189 You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).
 190
 191 =head1 BUGS
 192
 193 Please report any bugs or feature requests to C<bug-bit-morsesignals-receiver 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.
 194
 195 =head1 SUPPORT
 196
 197 You can find documentation for this module with the perldoc command.
 198
 199     perldoc Bit::MorseSignals::Receiver
 200
 201 =head1 COPYRIGHT & LICENSE
 202
 203 Copyright 2008 Vincent Pit, all rights reserved.
 204
 205 This program is free software; you can redistribute it and/or modify it
 206 under the same terms as Perl itself.
 207
 208 =cut
 209
 210 1; # End of Bit::MorseSignals::Receiver