.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "POE::Component::RSSAggregator 3pm" .TH POE::Component::RSSAggregator 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" POE::Component::RSSAggregator \- Watch Muliple RSS Feeds for New Headlines .SH "VERSION" .IX Header "VERSION" Version 1.11 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& #!/usr/bin/perl \& use strict; \& use warnings; \& use POE; \& use POE::Component::RSSAggregator; \& \& my @feeds = ( \& { url => "http://www.jbisbee.com/rdf/", \& name => "jbisbee", \& delay => 10, \& }, \& { url => "http://lwn.net/headlines/rss", \& name => "lwn", \& delay => 300, \& }, \& ); \& \& POE::Session\->create( \& inline_states => { \& _start => \e&init_session, \& handle_feed => \e&handle_feed, \& }, \& ); \& \& $poe_kernel\->run(); \& \& sub init_session { \& my ( $kernel, $heap, $session ) = @_[ KERNEL, HEAP, SESSION ]; \& $heap\->{rssagg} = POE::Component::RSSAggregator\->new( \& alias => \*(Aqrssagg\*(Aq, \& debug => 1, \& callback => $session\->postback("handle_feed"), \& tmpdir => \*(Aq/tmp\*(Aq, # optional caching \& ); \& $kernel\->post( \*(Aqrssagg\*(Aq, \*(Aqadd_feed\*(Aq, $_ ) for @feeds; \& } \& \& sub handle_feed { \& my ( $kernel, $feed ) = ( $_[KERNEL], $_[ARG1]\->[0] ); \& for my $headline ( $feed\->late_breaking_news ) { \& \& # do stuff with the XML::RSS::Headline object \& print $headline\->headline . "\en"; \& } \& } .Ve .SH "CONSTRUCTORS" .IX Header "CONSTRUCTORS" .ie n .SS "POE::Component::RSSAggregator\->new( %hash );" .el .SS "POE::Component::RSSAggregator\->new( \f(CW%hash\fP );" .IX Subsection "POE::Component::RSSAggregator->new( %hash );" Create a new instace of PoCo::RSSAggregator. .IP "\(bu" 4 alias .Sp \&\s-1POE\s0 alias to use for your instance of PoCo::RSSAggregator. .IP "\(bu" 4 debug .Sp Boolean value to turn on verbose output. (debug is also passed to XML::RSS::Feed instances to turn on verbose output as well) .IP "\(bu" 4 tmpdir .Sp The tmpdir argument is passed on to XML::RSS::Feed as the directory to cache \s-1RSS\s0 between fetches (and instances). .IP "\(bu" 4 http_alias .Sp Optional. Alias of an existing PoCoCl::HTTP. .IP "\(bu" 4 follow_redirects .Sp Optional. Only if you don't have an exiting PoCoCl::HTTP. Argument is passed to PoCoCl::HTTP to tell it the follow redirect level. (Defaults to 2) .SH "METHODS" .IX Header "METHODS" .ie n .SS "$rssagg\->feed_list" .el .SS "\f(CW$rssagg\fP\->feed_list" .IX Subsection "$rssagg->feed_list" Returns the current feeds as an array or array_ref. .ie n .SS "$rssagg\->feeds" .el .SS "\f(CW$rssagg\fP\->feeds" .IX Subsection "$rssagg->feeds" Returns a hash ref of feeds with the key being the feeds name. The hash reference you that belongs to the key is passed to XML::RSS::Feed\->new($hash_ref). ( see XML::RSS::Feed ) .ie n .SS "$rssagg\->feed( $feed_name )" .el .SS "\f(CW$rssagg\fP\->feed( \f(CW$feed_name\fP )" .IX Subsection "$rssagg->feed( $feed_name )" Accessor to access a the XML::RSS::Feed object via a feed's name. .ie n .SS "$rssagg\->add_feed( $hash_ref )" .el .SS "\f(CW$rssagg\fP\->add_feed( \f(CW$hash_ref\fP )" .IX Subsection "$rssagg->add_feed( $hash_ref )" The hash reference you pass in to add_feed is passed to XML::RSS::Feed\->new($hash_ref). ( see XML::RSS::Feed ) .ie n .SS "$rssagg\->remove_feed( $feed_name )" .el .SS "\f(CW$rssagg\fP\->remove_feed( \f(CW$feed_name\fP )" .IX Subsection "$rssagg->remove_feed( $feed_name )" Pass in the name of the feed you want to remove. .ie n .SS "$rssagg\->pause_feed( $feed_name )" .el .SS "\f(CW$rssagg\fP\->pause_feed( \f(CW$feed_name\fP )" .IX Subsection "$rssagg->pause_feed( $feed_name )" Pass in the name of the feed you want to pause. .ie n .SS "$rssagg\->resume_feed( $feed_name )" .el .SS "\f(CW$rssagg\fP\->resume_feed( \f(CW$feed_name\fP )" .IX Subsection "$rssagg->resume_feed( $feed_name )" Pass in the name of the feed you want to resume (that you previously paused). .ie n .SS "$rssagg\->shutdown" .el .SS "\f(CW$rssagg\fP\->shutdown" .IX Subsection "$rssagg->shutdown" Shutdown the instance of PoCo::RSSAggregator. .SH "AUTHOR" .IX Header "AUTHOR" Jeff Bisbee, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-poe\-component\-rssaggregator at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc POE::Component::RSSAggregator .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" Special thanks to Rocco Caputo, Martijn van Beers, Sean Burke, Prakash Kailasa and Randal Schwartz for their help, guidance, patience, and bug reports. Guys thanks for actually taking time to use the code and give good, honest feedback. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2006 Jeff Bisbee, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" XML::RSS::Feed, XML::RSS::Headline, XML::RSS::Headline::PerlJobs, XML::RSS::Headline::Fark