use strict;
use warnings;
-use Carp qw/croak/;
-use POSIX qw/SIGUSR1 SIGUSR2/;
-use Time::HiRes qw/usleep/;
+use Carp qw<croak>;
+use POSIX qw<SIGUSR1 SIGUSR2>;
+use Time::HiRes qw<usleep>;
use Bit::MorseSignals::Emitter;
-use base qw/Bit::MorseSignals::Emitter/;
+use base qw<Bit::MorseSignals::Emitter>;
=head1 NAME
=head1 VERSION
-Version 0.15
+Version 0.17
=cut
-our $VERSION = '0.15';
+our $VERSION = '0.17';
+
+=head1 WARNING
+
+Due to the POSIX signals specification (which I wasn't aware of at the time I wrote this module), this module is by nature completely unreliable and will never work properly.
+It is therefore B<deprecated>.
+Please don't use it (if you were actually crazy enough to use it).
=head1 SYNOPSIS
use IPC::MorseSignals::Emitter;
- my $deuce = new IPC::MorseSignals::Emitter speed => 1024;
+ my $deuce = IPC::MorseSignals::Emitter->new(speed => 1024);
$deuce->post('HLAGH') for 1 .. 3;
$deuce->send($pid);
=head1 METHODS
-=head2 C<< new < delay => $seconds, speed => $bauds, %bme_options > >>
+=head2 C<new>
+
+ my $ime = IPC::MorseSignals::Emitter->new(
+ delay => $seconds,
+ speed => $bauds,
+ %bme_options,
+ );
-Creates a new emitter object. C<delay> specifies the delay between two sends, in seconds, while C<speed> is the number of bits sent per second. The delay value has priority over the speed. Default delay is 1 second. Extra arguments are passed to L<Bit::MorseSignals::Emitter/new>.
+Creates a new emitter object.
+C<delay> specifies the delay between two sends, in seconds, while C<speed> is the number of bits sent per second.
+The delay value has priority over the speed, and defaults to 1 second.
+Extra arguments are passed to L<Bit::MorseSignals::Emitter/new>.
=cut
bless $self, $class;
}
-=head2 C<send $pid>
+=head2 C<send>
+
+ $ime->send($pid);
Sends messages enqueued with L<Bit::MorseSignals::Emitter/post> to the process C<$pid> (or to all the C<@$pid> if C<$pid> is an array reference, in which case duplicated targets are stripped off).
}
}
-=head2 C<< delay < $seconds > >>
+=head2 C<delay>
+
+ my $delay = $ime->delay;
+ $ime->delay($seconds);
Returns the current delay in seconds, or set it if an argument is provided.
return $self->{delay};
}
-=head2 C<< speed < $bauds > >>
+=head2 C<speed>
+
+ my $speed = $ime->speed;
+ $ime->speed($bauds);
Returns the current speed in bauds, or set it if an argument is provided.
=head1 BUGS
-Please report any bugs or feature requests to C<bug-ipc-morsesignals-emitter at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IPC-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-ipc-morsesignals-emitter at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IPC-MorseSignals>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
=head1 COPYRIGHT & LICENSE
-Copyright 2007-2008 Vincent Pit, all rights reserved.
+Copyright 2007,2008,2013,2017 Vincent Pit, all rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.