File Coverage

blib/lib/POE/Declare/Meta/Event.pm

Criterion	Covered	Total	%
statement	16	16	100.0
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod			n/a
total	22	22	100.0

package POE::Declare::Meta::Event;

=pod

=head1 NAME

POE::Declare::Meta::Event - Declares a named POE event

=head1 SYNOPSIS

  use POE::Declare;

  sub shutdown : Event {
      my $self = $_[SELF];

      # Shutdown our child first
      $self->child->post('shutdown');

      # Wait for the child to tell us it is finished
      return 1;
  }

=head1 DESCRIPTION

Taking advantage of the subroutine attribute feature of recent versions
of Perl, the C attribute is used to register a function/method as
an event that can be targetted by POE events.

In an Event, the non-core parameter constant SELF is used to retrieve
the current object (Since all objects are stored in the session heap,
SELF is actually just an alias for HEAP).

=cut

use 5.008007;
use strict;
use warnings;
use POE::Declare::Meta::Slot ();

use vars qw{$VERSION @ISA};
BEGIN {
	$VERSION = '0.23_01';
	@ISA     = 'POE::Declare::Meta::Slot';
}

1;

=pod

=head1 SUPPORT

Bugs should be always be reported via the CPAN bug tracker at

L

For other issues, or commercial enhancement or support, contact the author.

=head1 AUTHORS

Adam Kennedy [e-mail]

=head1 SEE ALSO

L, L

=head1 COPYRIGHT

Copyright 2006 - 2009 Adam Kennedy.

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

The full text of the license can be found in the
LICENSE file included with this module.

=cut