Public Attributes

Currently Reflex::POE::Wheel exposes the raw POE::Wheel via its wheel() attribute. This will be undefined if the wheel hasn't been set up yet.

Public Methods

The wheel_id() method returns the ID of the POE::Wheel being managed. "$foo->wheel()->ID()" can also be used instead.

demolish_wheel

Cause the internal wheel to be demolished. Provided as a method since some wheels may require special handling.

put

put() sends its parameters to the POE::Wheel's put() method.

        $reflex_poe_wheel->put("one", "two");

Required Subclass Methods

event_to_index

event_to_index() maps POE::Wheel events to consecutive integer event IDs. event_emit_names() will provide Reflex-friendly event names based on the event IDs. event_param_names() will provide parameter names that correspond to the wheel's positional parameters.

This mapping is from Reflex::POE::Wheel::Run. It will make more sense in the context of event_emit_names() and event_param_names().

        sub event_to_index {
                return(
                        {
                                StdinEvent  => 0,
                                StdoutEvent => 1,
                                StderrEvent => 2,
                                ErrorEvent  => 3,
                                CloseEvent  => 4,
                        },
                );
        }

event_emit_names

event_emit_names() returns an array reference that maps Reflex::POE::Wheel's event IDs to Reflex-friendly event names.

Here's an example from Reflex::POE::Wheel::Run. The wheel's StdinEvent (ID 0) is emitted as "stdin" (the 0th element in event_emit_names()). StdoutEvent becomes "stdout", and so on.

        sub event_emit_names {
                return(
                        [
                                'stdin',  # StdinEvent
                                'stdout', # StdoutEvent
                                'stderr', # StderrEvent
                                'error',  # ErrorEvent
                                'closed', # ClosedEvent
                        ],
                );
        }

event_param_names

event_param_names() returns an array reference that maps Reflex::POE::Wheel's event IDs to Reflex-friendly lists of parameter names. The underlying POE::Wheel's positional parameters will be mapped to these names before the Reflex object emits them.

Here's yet another example from Reflex::POE::Wheel::Run. StdinEvent and StdoutEvent each return two parameters. The Reflex object will emit their ARG0 as the named parameter "output", and ARG1 becomes the named parameter "wheel_id".

        sub event_param_names {
                return(
                        [
                                [ "wheel_id" ],
                                [ "output", "wheel_id" ],
                                [ "output", "wheel_id" ],
                                [ "operation", "errnum", "errstr", "wheel_id", "handle_name" ],
                                [ "wheel_id" ],
                        ]
                );
        }

wheel_class

wheel_class() returns a simple string---the class name of the wheel to construct.

valid_params

The valid_params() method returns a hash reference keyed on valid constructor parameters. Values don't matter at this time. Reflex::POE::Wheel uses this hash reference to pre-validate construction of underlying POE::Wheel objects.

POE::Wheel::Run takes quite a lot of parameters, most of which are optional.

        sub valid_params {
                return(
                        {
                                CloseOnCall => 1,
                                Conduit => 1,
                                Filter => 1,
                                Group => 1,
                                NoSetPgrp => 1,
                                NoSetSid => 1,
                                Priority => 1,
                                Program => 1,
                                ProgramArgs => 1,
                                StderrDriver => 1,
                                StderrFilter => 1,
                                StdinDriver => 1,
                                StdinFilter => 1,
                                StdioDriver => 1,
                                StdioFilter => 1,
                                StdoutDriver => 1,
                                StdoutFilter => 1,
                                User => 1,
                        }
                );
        }