Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Reflex::Role::Wakeup(3User Contributed Perl DocumentatiReflex::Role::Wakeup(3)

NAME
       Reflex::Role::Wakeup - set a wakeup callback for	a particular UNIX time

VERSION
       This document describes version 0.100, released on April	02, 2017.

SYNOPSIS
	       package Reflex::Wakeup;

	       use Moose;
	       extends 'Reflex::Base';

	       has when	=> ( isa => 'Num', is  => 'rw' );

	       with 'Reflex::Role::Wakeup' => {
		       when	     =>	"when",
		       cb_wakeup     =>	"on_time",
		       method_stop   =>	"stop",
		       method_reset  =>	"reset",
	       };

	       1;

DESCRIPTION
       Reflex::Role::Wakeup is a parameterized role.  Each time	it's consumed,
       it adds another non-blocking wakeup callback to a class.	 These
       callback	will be	invoked	at particular UNIX times, established by the
       contents	of the "when" attributes named at composition time.

       Reflex::Wakeup in the SYNOPSIS consumes a single	Reflex::Role::Wakeup.
       The parameters define the names of attributes that control the timer's
       behavior, the names of callback methods,	and the	names of methods that
       manipulate the timer.

   Required Role Parameters
       None.  All role parameters have defaults.

   Optional Role Parameters
       when

       "when" names an attribute in the	consumer that must hold	the role's
       wakeup time.  Wakeup times are specified	as seconds since the UNIX
       epoch.  Reflex usually supports fractional seconds, but this ultimately
       depends on the event loop being used.

       Refex::Role::Wakeup uses	the attribute name in "when" to	differentiate
       between multiple	applications of	the same role to the same class.
       Reflex roles are	building blocks	of program behavior, and it's
       reasonable to expect a class to need multiple building blocks of	the
       same type.  For instance, multiple wakeup timers	for different
       purposes.

       method_stop

       Reflex::Role::Wakeup will provide a method to stop the timer.  This
       method will become part of the consuming	class, per Moose.
       "method_stop" allows the	consumer to define the name of that method.
       By default, the method will be named:

	       $method_stop = "stop_" .	$when_name;

       where $when_name	is the attribute name supplied by the "when"
       parameter.

       The stop	method neither takes parameters	nor returns anything.

       method_reset

       "method_reset" allows the role's	consumer to override the default reset
       method name.  The default is "stop_${when_name}", where $when_name is
       the attribute name provided in the "when" parameter.

       All Reflex methods accept a hashref of named parameters.	 Currently the
       reset method accepts one	named parameter, "when".  The value of "when"
       must be the new time to trigger a callback.  If "when" isn't provided,
       the wakeup callback will	happen at the previous time set	by this
       module.

	       $self->reset_name( { when => time() + 60	} );

       One may also set	the when() attribute and reset() the timer as two
       distinct	calls.

	       $self->time( time() + 60	);  # 60 seconds from now
	       $self->reset_time();

       cb_wakeup

       "cb_wakeup" overrides the default method	name that will be called when
       the "when" time arrives.	 The default is	"on_${when_name}_wakeup".

       These callbacks receive no paramaters.

EXAMPLES
       Reflex::Wakeup is one example of	using Reflex::Role::Wakeup.

SEE ALSO
       Please see those	modules/websites for more information related to this
       module.

       o   Reflex

       o   Reflex

       o   Reflex::Wakeup

       o   Reflex::Role

       o   "ACKNOWLEDGEMENTS" in Reflex

       o   "ASSISTANCE"	in Reflex

       o   "AUTHORS" in	Reflex

       o   "BUGS" in Reflex

       o   "BUGS" in Reflex

       o   "CONTRIBUTORS" in Reflex

       o   "COPYRIGHT" in Reflex

       o   "LICENSE" in	Reflex

       o   "TODO" in Reflex

BUGS AND LIMITATIONS
       You can make new	bug reports, and view existing ones, through the web
       interface at <http://rt.cpan.org/Public/Dist/Display.html?Name=Reflex>.

AUTHOR
       Rocco Caputo <rcaputo@cpan.org>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2017 by Rocco Caputo.

       This is free software; you can redistribute it and/or modify it under
       the same	terms as the Perl 5 programming	language system	itself.

AVAILABILITY
       The latest version of this module is available from the Comprehensive
       Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find
       a CPAN site near	you, or	see <https://metacpan.org/module/Reflex/>.

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS	LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE	EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN	WRITING	THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS	IS" WITHOUT WARRANTY OF	ANY KIND,
       EITHER EXPRESSED	OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF	THE SOFTWARE IS	WITH
       YOU. SHOULD THE SOFTWARE	PROVE DEFECTIVE, YOU ASSUME THE	COST OF	ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR	AGREED TO IN WRITING
       WILL ANY	COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE	SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE	USE OR INABILITY TO USE	THE
       SOFTWARE	(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED	INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.24.1			  2017-04-02	       Reflex::Role::Wakeup(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO | BUGS AND LIMITATIONS | AUTHOR | COPYRIGHT AND LICENSE | AVAILABILITY | DISCLAIMER OF WARRANTY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Reflex::Role::Wakeup&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help