NAME

Reflex::Role::Timeout - set a wakeup callback for a relative delay

VERSION

version 0.088

SYNOPSIS

        package Reflex::Timeout;

        use Moose;
        extends 'Reflex::Base';

        has delay       => ( isa => 'Num', is  => 'ro' );
        has auto_start  => ( isa => 'Bool', is => 'ro', default => 1 );

        with 'Reflex::Role::Timeout' => {
                delay         => "delay",
                cb_timeout    => "on_done",
                auto_start    => "auto_start",
                method_start  => "start",
                method_stop   => "stop",
                method_reset  => "reset",
        };

        1;

DESCRIPTION

Reflex::Role::Timeout is a parameterized role. Each time it's consumed, it adds another non-blocking relative delay callback to a class. These callback will be invoked after a particular number of seconds have elapsed. The delay is contained in an attribute named by the role's delay parameter.

Reflex::Timeout in the SYNOPSIS consumes a single Reflex::Role::Timeout. 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

delay

delay names an attribute in the consumer that must hold the role's inactivity time, in seconds. The role will trigger a callback after that amount of time has elapsed, unless the timeout is stopped or reset before then.

Reflex usually supports fractional seconds, but this ultimately depends on the event loop being used.

Refex::Role::Timeout uses the attribute name in delay 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, a login prompt may have a short timeout to wait for input and a longer timeout to wait for authentication.

auto_start

Timeouts will automatically start if the value of the attribute named in auto_start is true. Otherwise, the class consuming this role must call the role's start method, named in method_start.

method_stop

Reflex::Role::Timeout 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_" . $delay_name;

where $delay_name is the attribute name supplied by the delay 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 "reset_${timeout_name}", where $timeout_name is the attribute name provided in the timeout parameter.

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

        $self->reset_name( { delay => 60 } );

One may also set the delay attribute and reset the timer as two distinct calls.

        $self->delay( 60 );  # 60 seconds from now
        $self->reset_name();

method_start

This role provides a method to start timeouts, otherwise timeouts would never run if auto_start were false. The method_start can be used to override the default start method name, which is "start_${delay_name}". $delay_name is the name of the attribute provided in the delay role parameter.

cb_timeout

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

These callbacks receive no paramaters.

EXAMPLES

Reflex::Timeout is one example of using Reflex::Role::Timeout.

SEE ALSO

Reflex Reflex::Timeout Reflex::Role

"ACKNOWLEDGEMENTS" in Reflex "ASSISTANCE" in Reflex "AUTHORS" in Reflex "BUGS" in Reflex "BUGS" in Reflex "CONTRIBUTORS" in Reflex "COPYRIGHT" in Reflex "LICENSE" in Reflex "TODO" in Reflex

cpanm Reflex

perl -MCPAN -e shell
install Reflex