NAME

POE::API::Ctl -- Switches and Knobs for POE Internals

SYNOPSIS

    use POE::API::Ctl;

    my $value = poectl('kernel.id');

    my $new_value = poectl('some.name' => 'pie');

    my $ctls = poectl();

DESCRIPTION

This module provides sysctl like functionality for POE. It exports into the calling namespace a function named poectl.

FUNCTIONS

poectl

    my $value = poectl('kernel.id');
    my $new_value = poectl('some.name' => 'pie');
    my $ctls = poectl();

This function is exported into the calling namespace on module load. It provides the ability to get and set POE control values. All parameters are optional. If no parameters are given, a hash reference containing a copy of all POE control entries is returned. If one parameter is given, the value of that POE control entry is returned. If two parameters are given, the value of the POE control entry referenced by the first parameter is set to the contents of the second parameter. In this case, the new value of the POE control entry is returned. If more than two parameters are given, an error is thrown and undef is returned.

Control entries can be locked by the POE internals. If a write is attempted to a locked entry, the write will not succeed and the old value will remain.

SEE ALSO

See POE::Kernel and POE::Resource::Controls.

AUTHORS & COPYRIGHTS

Original Author: Matt Cashner (sungo@pobox.com)

Please see POE for more information about authors and contributors.