NAME

MooseX::POE::Meta::Trait::Object - The base class role for MooseX::Poe

SYNOPSIS

  package Counter;
  use MooseX::Poe;

  has name => (
      isa     => 'Str',
      is      => 'rw',
      default => sub { 'Foo ' },
  );

  has count => (
      isa     => 'Int',
      is      => 'rw',
      lazy    => 1,
      default => sub { 0 },
  );

  sub START {
      my ($self) = @_;
      $self->yield('increment');
  }

  sub increment {
      my ($self) = @_;
      $self->count( $self->count + 1 );
      $self->yield('increment') unless $self->count > 3;
  }

  no MooseX::Poe;

DESCRIPTION

MooseX::POE::Meta::TraitObject is a role that is applied to the object base classe (usually Moose::Object) that implements a POE::Session.

DEFAULT METHODS

get_session_id

Get the internal POE Session ID, this is useful to hand to other POE aware functions.

yield

call

delay

alarm

alarm_add

delay_add

alarm_set

alarm_adjust

alarm_remove

alarm_remove_all

delay_set

delay_adjust

A cheap alias for the same POE::Kernel function which will gurantee posting to the object's session.

STARTALL

Along similar lines to Moose's BUILDALL method which calls all the BUILD methods, this function will call all the START methods in your inheritance hierarchy automatically when POE first runs your session. (This corresponds to the _start event from POE.)

STOPALL

Along similar lines to STARTALL, but for STOP instead.

PREDEFINED EVENTS

START

STOP

DEFAULT

CHILD

PARENT

AUTHOR

Chris Prather <perigrin@cpan.org>

Ash Berlin <ash@cpan.org>

CONTRIBUTORS

Torsten Raudssus <torsten@raudssus.de>

LICENCE AND COPYRIGHT

Copyright (c) 2007-2009, Chris Prather <perigrin@cpan.org>, Ash Berlin <ash@cpan.org>. All rights reserved.

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

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.