POE::Component::CPAN::LinksToDocs::No404s::Remember - non-blocking wrapper around CPAN::LinksToDocs::No404s::Remember module
use strict;
use warnings;
use POE qw(Component::CPAN::LinksToDocs::No404s::Remember);
my $poco = POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn;
POE::Session->create(
package_states => [ main => [qw(_start response )] ],
);
$poe_kernel->run;
sub _start {
$poco->link_for( {
tags => 'map,RE,Acme::BabyEater,POE',
event => 'response',
}
);
}
sub response {
print "$_\n" for @{ $_[ARG0]->{response} };
$poco->shutdown;
}
Using event based interface is also possible of course.
The module is a non-blocking wrapper around CPAN::LinksToDocs::No404s::Remember module which provides interface to lookup documentation by eating either predefined tags or module names
my $poco = POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn;
POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn(
alias => 'linker',
obj_args => {
tags => { foos => 'bars' },
db_file => 'some_file.db',
},
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::Remember object. It takes a few arguments, all of which are optional. The possible arguments are as follows:
POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn(
alias => 'linker'
);
Optional. Specifies a POE Kernel alias for the component.
POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn(
obj_args => {
tags => { foos => 'bars', },
db_file => 'some_file.db',
},
);
The obj_args argument takes a hashref as a value which will be dereferenced directly into CPAN::LinksToDocs::No404s::Remember constructor. See documentation for the constructor of CPAN::LinksToDocs::No404s::Remember module for possible arguments this hashref can contain.
my $poco = POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn(
options => {
trace => 1,
default => 1,
},
);
Optional. A hashref of POE Session options to pass to the component's session.
my $poco = POE::Component::CPAN::LinksToDocs::No404s::Remember->spawn(
debug => 1
);
When set to a true value turns on output of debug messages. Defaults to: 0.
$poco->link_for( {
event => 'event_for_output',
tags => 'map,RE,Acme::BabyEater,POE',
_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.
my $poco_id = $poco->session_id;
Takes no arguments. Returns component's session ID.
$poco->shutdown;
Takes no arguments. Shuts down the component.
$poe_kernel->post( linker => link_for => {
event => 'event_for_output',
tags => 'map,RE,Acme::BabyEater,POE',
_blah => 'pooh!',
session => 'other',
}
);
Instructs the component to fetch some docs for the tags or module names you specify. Takes a hashref as an argument, the possible keys/value of that hashref are as follows:
{ event => 'results_event', }
Mandatory. Specifies the name of the event to emit when results are ready. See OUTPUT section for more information.
{ tags => 'map,RE,Acme::BabyEater,POE' }
Mandatory. Takes a scalar string containing comma separated predefined tags or module names. For list of predefined tags see CPAN::LinksToDocs.
{ 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 => 'random',
_another => 'more',
}
Optional. Any keys starting with _ (underscore) will not affect the component and will be passed back in the result intact.
$poe_kernel->post( linker => 'shutdown' );
Takes no arguments. Tells the component to shut itself down.
$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' => [
'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::Remember's link_for() method. See documentation for CPAN::LinksToDocs::No404s::Remember module for more information.
{ 'tags' => 'map,grep,Acme::BabyEater,Zoffer', }
The tags key will contain whatever you've passed in tags argument to link_for() method/event.
{ '_blah' => 'foos' }
Any arguments beginning with _ (underscore) passed into the link_for() event/method will be present intact in the result.
POE, CPAN::LinksToDocs::No404s::Remember
Zoffix Znet, <zoffix at cpan.org> (http://zoffix.com, http://haslayout.net
Please report any bugs or feature requests to bug-poe-component-cpan-linkstodocs-no404s-remember at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-CPAN-LinksToDocs-No404s-Remember. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
You can find documentation for this module with the perldoc command.
perldoc POE::Component::CPAN::LinksToDocs::No404s::Remember
You can also look for information at:
http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-CPAN-LinksToDocs-No404s-Remember
http://annocpan.org/dist/POE-Component-CPAN-LinksToDocs-No404s-Remember
http://cpanratings.perl.org/d/POE-Component-CPAN-LinksToDocs-No404s-Remember
http://search.cpan.org/dist/POE-Component-CPAN-LinksToDocs-No404s-Remember
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.
