/ 
POE-Component-CPAN-LinksToDocs-No404s-0.001
/ POE::Component::CPAN::LinksToDocs::No404s

NAME

POE::Component::CPAN::LinksToDocs::No404s - non-blocking wrapper around CPAN::LinksToDocs::No404s

SYNOPSIS

SYNOPSIS

use strict;
use warnings;

use POE qw(Component::CPAN::LinksToDocs::No404s);

my $poco = POE::Component::CPAN::LinksToDocs::No404s->spawn;

POE::Session->create(
    package_states => [ main => [qw(_start response )] ],
);

$poe_kernel->run;

sub _start {
    $poco->link_for( {
            tags => 'map,RE,Carp,Acme::Something,OtherModule',
            event => 'response',
        }
    );
}

sub response {
    print "$_\n" for @{ $_[ARG0]->{results} };

    $poco->shutdown;
}

Using event based interface is also possible of course.

DESCRIPTION

The module is a non-blocking wrapper around CPAN::LinksToDocs::No404s which provides means to get documentation to http://search.cpan.org documentation by giving predefined "tags" or module names. To find out more about "tags" see TAGS section in CPAN::LinksToDocs::No404s module's documentation.

CONSTRUCTOR

spawn

my $poco = POE::Component::CPAN::LinksToDocs::No404s->spawn;

POE::Component::CPAN::LinksToDocs::No404s->spawn(
    alias => 'docs',
    obj_args => {
        tags => {
            foos => 'http://bars.com/',
        },
        timeout => 20,
    },
    options => {
        debug => 1,
        trace => 1,
        # POE::Session arguments for the component
    },
    debug => 1, # output some debug info
);

The spawn method returns a POE::Component::CPAN::LinksToDocs::No404s object. It takes a few arguments, all of which are optional. The possible arguments are as follows:

alias

POE::Component::CPAN::LinksToDocs::No404s->spawn(
    alias => 'docs'
);

Optional. Specifies a POE Kernel alias for the component.

obj_args

my $poco = POE::ComponentCPAN::LinksToDocs::No404s->spawn(
    obj_args => {
        tags => {
            foos => 'http://bars.com/',
        },
        timeout => 20,
    }
);

Optional. The obj_args argument takes a hashref as a value. The hashref must contain CPAN::LinksToDocs::No404s object's constructor arguments. See CPAN::LinksToDocs::No404s's constructor (new() method) documentation for more information.

options

my $poco = POE::Component::CPAN::LinksToDocs::No404s->spawn(
    options => {
        trace => 1,
        default => 1,
    },
);

Optional. A hashref of POE Session options to pass to the component's session.

debug

my $poco = POE::Component::CPAN::LinksToDocs::No404s->spawn(
    debug => 1
);

When set to a true value turns on output of debug messages. Defaults to: 0.

METHODS

$poco->link_for( {
        event => 'event_for_output',
        tags  => 'map,grep,Acme::Something,RE,OOP,SomeModule',
        _blah => 'pooh!',
        session => 'other',
    }
);

Takes a hashref as an argument, does not return a sensible return value. See link_for event's description for more information.

session_id

my $poco_id = $poco->session_id;

Takes no arguments. Returns component's session ID.

shutdown

$poco->shutdown;

Takes no arguments. Shuts down the component.

ACCEPTED EVENTS

$poe_kernel->post( docs => link_for => {
        event => 'event_for_output',
        tags  => 'map,grep,Acme::Something,OOP,SomeModule',
        _blah => 'pooh!',
        session => 'other',
    }
);

Instructs the component to make out the links (and check the ones that need checking) for "tags" given in the tags argument. Takes a hashref as an argument, the possible keys/value of that hashref are as follows:

event

{ event => 'results_event', }

Mandatory. Specifies the name of the event to emit when results are ready. See OUTPUT section for more information.

tags

{ tags => 'map,grep,OOP,Acme::Something,SomeModule' }

Mandatory. Takes a scalar containing comma separated one or more "tags". See TAGS section in CPAN::LinksToDocs::No404s module's documentation for more information about possible "tags".

session

{ session => 'other' }

{ session => $other_session_reference }

{ session => $other_session_ID }

Optional. Takes either an alias, reference or an ID of an alternative session to send output to.

user defined

{
    _user    => 'random',
    _another => 'more',
}

Optional. Any keys starting with _ (underscore) will not affect the component and will be passed back in the result intact.

shutdown

$poe_kernel->post( docs => 'shutdown' );

Takes no arguments. Tells the component to shut itself down.

OUTPUT

$VAR1 = {
    'response' => [
        'http://perldoc.perl.org/functions/map.html',
        'http://perldoc.perl.org/functions/grep.html',
        'http://search.cpan.org/perldoc?Acme::BabyEater',
        'Not found'
    ],
    'tags' => 'map,grep,Acme::BabyEater,Zoffer',
    '_user' => 'foos',
};

The event handler set up to handle the event which you've specified in the event argument to link_for() method/event will recieve input in the $_[ARG0] in a form of a hashref. The possible keys/value of that hashref are as follows:

response

{
    'response' => [
        'http://perldoc.perl.org/functions/map.html',
        'http://perldoc.perl.org/functions/grep.html',
        'http://search.cpan.org/perldoc?Acme::BabyEater',
        'Not found'
    ],
}

The response key will contain a (possibly empty) arrayref of links to documentation. This is the same arrayref that you would get from CPAN::LinksToDocs::No404s's link_for() method. See documentation for CPAN::LinksToDocs::No404s module for more information.

tags

{ 'tags' => 'map,grep,Acme::BabyEater,Zoffer', }

The tags key will contain whatever you've passed in tags argument to link_for() method/event.

user defined

{ '_blah' => 'foos' }

Any arguments beginning with _ (underscore) passed into the EXAMPLE() event/method will be present intact in the result.

SEE ALSO

POE, CPAN::LinksToDocs::No404s

AUTHOR

Zoffix Znet, <zoffix at cpan.org> (http://zoffix.com, http://haslayout.net)

BUGS

Please report any bugs or feature requests to bug-poe-component-cpan-linkstodocs-no404s at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-CPAN-LinksToDocs-No404s. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc POE::Component::CPAN::LinksToDocs::No404s

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2008 Zoffix Znet, all rights reserved.

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