POE::Component::WWW::Lipsum - non-blocking wrapper around WWW::Lipsum
use strict;
use warnings;
use POE qw/Component::WWW::Lipsum/;
my $poco = POE::Component::WWW::Lipsum->spawn;
POE::Session->create( package_states => [ main => [qw/_start lipsum/] ], );
$poe_kernel->run;
sub _start {
$poco->generate({
event => 'lipsum',
args => {
amount => 5,
what => 'paras',
start => 'no',
html => 1
},
}
);
}
sub lipsum {
my $in_ref = $_[ARG0];
print "$_\n" for @{ $in_ref->{lipsum} };
$poco->shutdown;
}
Using event based interface is also possible of course.
The module is a non-blocking wrapper around WWW::Lipsum which provides interface to retrieve lipsum text from http://lipsum.com/
spawn my $poco = POE::Component::WWW::Lipsum->spawn;
POE::Component::WWW::Lipsum->spawn(
alias => 'lipsum',
options => {
debug => 1,
trace => 1,
# POE::Session arguments for the component
},
debug => 1, # output some debug info
);
The spawn method returns a POE::Component::WWW::Lipsum object. It takes a few arguments, all of which are optional. The possible arguments are as follows:
alias->spawn( alias => 'lipsum' );
Optional. Specifies a POE Kernel alias for the component.
options ->spawn(
options => {
trace => 1,
default => 1,
},
);
Optional. A hashref of POE Session options to pass to the component's session.
debug ->spawn(
debug => 1
);
When set to a true value turns on output of debug messages. Defaults to: 0.
generate $poco->generate( {
event => 'event_for_output',
args => {
amount => 5,
what => 'paras',
start => 'no',
html => 1,
},
_blah => 'pooh!',
session => 'other',
}
);
Takes a hashref as an argument, does not return a sensible return value. See generate event's description for more information.
session_idmy $poco_id = $poco->session_id;
Takes no arguments. Returns component's session ID.
shutdown$poco->shutdown;
Takes no arguments. Shuts down the component.
generate $poe_kernel->post( lipsum => generate => {
event => 'event_for_output',
args => {
amount => 5,
what => 'paras',
start => 'no',
html => 1,
},
_blah => 'pooh!',
session => 'other',
}
);
Instructs the component to fetch some Lorem Ipsum text from http://lipsum.com/. 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.
args {
args => {
amount => 5,
what => 'paras',
start => 'no',
html => 1,
},
}
Mandatory. The args key takes a hashref as its value. This hashref will be directly dereferenced into WWW::Lipsum generate() method. See documentation for WWW::Lipsum for possible arguments.
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 => '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( lipsum => 'shutdown' );
Takes no arguments. Tells the component to shut itself down.
$VAR1 = {
'args' => {
'amount' => 2,
'html' => 1,
'what' => 'paras',
'start' => 'no'
},
'lipsum' => [
'<p>Lipsum text here</p>',
'<p>Lipsum text here (cut for brevity)</p>',
],
_user => 'defined args',
};
The event handler set up to handle the event which you've specified in the event argument to generate() method/event will recieve input in the $_[ARG0] in a form of a hashref. The possible keys/value of that hashref are as follows:
lipsum {
'lipsum' => [
'<p>Lipsum text here</p>',
'<p>Lipsum text here (cut for brevity)</p>',
],
}
The lipsum key will contain an arrayref elements of which will be the generated Lorem Ipsum text. Note: if an error occured the lipsum key will not be present. See error below.
error {
'error' => 'Error: message',
},
In case of an error the lipsum key will not be present and an error key will be present instead which will contain an error message describing the problem. Note: at the time of this writing there is a minor bug in WWW::Lipsum due to which any errors related to LWP::UserAgent will not return an appropriate error message, just the text "Error: ". The bug report has been posted and may be fixed already.
args 'args' => {
'amount' => 2,
'html' => 1,
'what' => 'paras',
'start' => 'no'
},
The args key will contain the same hashref that you passed to generate() event/method args argument.
{ '_blah' => 'foos' }
Any arguments beginning with _ (underscore) passed into the generate() event/method will be present intact in the result.
Zoffix Znet, <zoffix at cpan.org> (http://zoffix.com, http://haslayout.net)
Please report any bugs or feature requests to bug-poe-component-www-lipsum at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-WWW-Lipsum. 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::WWW::Lipsum
You can also look for information at:
http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-WWW-Lipsum
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.
