=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>.
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.