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

FreeBSD Manual Pages

  
 
  

home | help
Reflex::Callback::MethUser)Contributed Perl DocumenReflex::Callback::Method(3)

NAME
       Reflex::Callback::Method	- Callback adapter for class and object
       methods

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

SYNOPSIS
       Used within Reflex:

	       package MethodHandler;
	       use Moose;
	       extends 'Reflex::Base';
	       use Reflex::Callbacks qw(cb_method);
	       use ExampleHelpers qw(eg_say);

	       has ticker => (
		       isa     => 'Maybe[Reflex::Interval]',
		       is      => 'rw',
	       );

	       sub BUILD {
		       my $self	= shift;
		       $self->ticker(
			       Reflex::Interval->new(
				       interval	   => 1	+ rand(),
				       auto_repeat => 1,
				       on_tick	   => cb_method($self, "callback"),
			       )
		       );
	       }

	       sub callback {
		       eg_say("method callback triggered");
	       }

	       MethodHandler->new()->run_all();

       Low-level usage:

	       {
		       package Object;
		       use Moose;

		       sub callback {
			       my ($self, $arg)	= @_;
			       print "$self says: hello, $arg->{name}\n";
		       }
	       }

	       my $object = Object->new();

	       my $cb =	Reflex::Callback::Method->new(
		       object	   => $object,
		       method_name => "callback"
	       );

	       $cb->deliver(greet => { name => "world" });

DESCRIPTION
       Reflex::Callback::Method	maps the generic Reflex::Callback interface to
       object and class	method callbacks.  Reflex::Callbacks' cb_method()
       function	simplifies callback creation.  cb_object(), also supplied by
       Reflex::Callbacks, is shorthand for setting several callbacks at	once
       on a single object or class.  Other syntactic sweeteners	are in
       development.

   new
       Reflex::Callback::Method's constructor takes two	named parameters.
       "object"	and "method_name" define the object and	method that will be
       invoked to handle the callback.

       Despite its name, "object" may also handle class	names.	In these
       cases, "method_name" will be invoked as a class method rather than on a
       particular instance of the class.

   deliver
       Reflex::Callback::Method's deliver() method invokes the object (or
       class) and method as defined during the callback's construction.
       deliver() takes two positional parameters: an event name	(which is not
       currently used for method callbacks), and a hashref of named parameters
       to be passed to the callback.

       deliver() returns whatever the coderef does.

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

       o   Reflex

       o   Reflex

       o   Reflex::Callback

       o   Reflex::Callbacks

       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::Callback::Method(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | 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::Callback::Method&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help