MooseX::POE::Aliased - A sane alias attribute for your MooseX::POE objects.

MooseX-POE documentation

Contained in the MooseX-POE distribution.

Index

NAME
VERSION
SYNOPSIS
DESCRIPTION
METHODS
- alias
ATTRIBUTES
AUTHORS
COPYRIGHT AND LICENSE

Code Index:

package MooseX::POE::Aliased
- BUILD
- _build_alias
__END__
EOF

NAME

MooseX::POE::Aliased - A sane alias attribute for your MooseX::POE objects.

VERSION

version 0.214

SYNOPSIS

	use MooseX::POE;

    with qw(MooseX::POE::Aliased);

    my $obj = Foo->new( alias => "blah" );

    $obj->alias("arf"); # previous one is removed, new one is set

    $obj->alias(undef); # no alias set

DESCRIPTION

This role provides an alias attribute for your MooseX::POE objects.

The attribute can be set, causing the current alias to be cleared and the new value to be set.

METHODS

alias

The alias to set for the session.

Defaults to the overload::StrVal of the object.

If the value is set at runtime the alias will be updated in the POE::Kernel.

A value of undef inhibits aliasing.

ATTRIBUTES

AUTHORS

Chris Prather <chris@prather.org>
Ash Berlin <ash@cpan.org>
Chris Williams <chris@bingosnet.co.uk>
Yuval (nothingmuch) Kogman
Torsten Raudssus <torsten@raudssus.de> http://www.raudssus.de/

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Chris Prather, Ash Berlin, Chris Williams, Yuval Kogman, Torsten Raudssus.

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

MooseX-POE documentation

Contained in the MooseX-POE distribution.

package MooseX::POE::Aliased;
BEGIN {
  $MooseX::POE::Aliased::VERSION = '0.214';
}
# ABSTRACT: A sane alias attribute for your MooseX::POE objects.
use MooseX::POE::Role;

use overload ();

use POE;

has alias => (
    isa => "Maybe[Str]",
    is  => "rw",
    builder     => "_build_alias",
    clearer     => "clear_alias",
    predicate   => "has_alias",
    trigger => sub {
        my ( $self, $alias ) = @_;
        $self->call( _update_alias => $alias );
    }
);

sub BUILD {
    my ($self) = @_;

    $self->call( _update_alias => $self->alias )
      if $self->has_alias;
}

sub _build_alias {
    my $self = shift;
    overload::StrVal($self);
}

event _update_alias => sub {
    my ( $kernel, $self, $alias ) = @_[KERNEL, OBJECT, ARG0];

    # we need to remove the prev alias like this because we don't know the
    # previous value.
    $kernel->alarm_remove_all();

	$kernel->alias_set($alias) if defined $alias;
};

__PACKAGE__;


__END__