X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FBit-MorseSignals.git;a=blobdiff_plain;f=lib%2FBit%2FMorseSignals%2FEmitter.pm;h=ee7118e0a77790ee700f18c6c5029d4529e204fa;hp=7e11c1dbe66f1865bb9343af5eebaf5f0bb6959e;hb=4edcf469e09bb23c40cdba77f905ce341b0ce771;hpb=7311d27d4099d8c1f0e011db45d53a21853ff703 diff --git a/lib/Bit/MorseSignals/Emitter.pm b/lib/Bit/MorseSignals/Emitter.pm index 7e11c1d..ee7118e 100644 --- a/lib/Bit/MorseSignals/Emitter.pm +++ b/lib/Bit/MorseSignals/Emitter.pm @@ -33,9 +33,11 @@ our $VERSION = '0.08'; =head1 DESCRIPTION -Base class for L emitters. Please refer to this module for more general information about the protocol. +Base class for L emitters. +Please refer to this module for more general information about the protocol. -The emitter object enqueues messages and prepares them one by one into L packets. It gives then back the bits of the packet in the order they should be sent. +The emitter object enqueues messages and prepares them one by one into L packets. +It gives then back the bits of the packet in the order they should be sent. =cut @@ -66,7 +68,8 @@ sub _count_bits { my $bme = Bit::MorseSignals::Emitter->new; -L object constructor. Currently does not take any optional argument. +L object constructor. +Currently does not take any optional argument. =cut @@ -87,7 +90,8 @@ sub new { $bme->post($msg, type => $type); -Adds C<$msg> to the message queue and, if no other message is currently processed, dequeue the oldest item and prepare it. The type is automatically chosen, but you may want to try to force it with the C option : C<$type> is then one of the C constants listed in L +Adds C<$msg> to the message queue and, if no other message is currently processed, dequeue the oldest item and prepare it. +The type is automatically chosen, but you may want to try to force it with the C option : C<$type> is then one of the C constants listed in L =cut @@ -162,7 +166,10 @@ sub post { =head2 C -If a message is being processed, pops the next bit in the packet. When the message is over, the next in the queue is immediatly prepared and the first bit of the new packet is given back. If the queue is empty, C is returned. You may want to use this method with the idiom : +If a message is being processed, pops the next bit in the packet. +When the message is over, the next in the queue is immediatly prepared and the first bit of the new packet is given back. +If the queue is empty, C is returned. +You may want to use this method with the idiom : while (defined(my $bit = $deuce->pop)) { ... @@ -275,7 +282,8 @@ You can contact me by mail or on C (vincent). =head1 BUGS -Please report any bugs or feature requests to C, or through the web interface at L. 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, or through the web interface at L. +I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT