.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 "Scrappy::Queue 3pm" .TH Scrappy::Queue 3pm "2021-01-07" "perl v5.32.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" Scrappy::Queue \- Scrappy HTTP Request Flow\-Control System .SH "VERSION" .IX Header "VERSION" version 0.94112090 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& #!/usr/bin/perl \& use Scrappy::Queue; \& \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add($url); \& \& while (my $url = $queue\->next) { \& ... $queue\->add(...); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Scrappy::Queue provides a system for saving URLs to a recordset/queue and iterating of them using the Scrappy framework. .SH "METHODS" .IX Header "METHODS" .SS "list" .IX Subsection "list" The list method return the list of URLs in the queue. This is returned in list context. .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& ... \& \& my @list = $queue\->list; .Ve .SS "add" .IX Subsection "add" The add method adds new URLs to the queue. Duplicate URLs will be ignored. .PP .Vb 2 \& my $queue = Scrappy::Queue\->new; \& $queue\->add($url); .Ve .SS "clear" .IX Subsection "clear" The clear method completely empties the queue and resets the cursor (loop position). .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& $queue\->clear; .Ve .SS "reset" .IX Subsection "reset" The reset method resets the cursor (loop position). .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& while (my $url = $queue\->next) { \& $queue\->reset if ...; # beware the infinate loop \& } \& \& $queue\->reset; .Ve .SS "current" .IX Subsection "current" The current method returns the \s-1URL\s0 in the current loop position. .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& while (my $url = $queue\->next) { \& last if ...; \& } \& \& print \*(Aqgreat\*(Aq if $url eq $queue\->current; .Ve .SS "next" .IX Subsection "next" The next method moves the cursor to the next loop position and returns the \s-1URL.\s0 .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& while (my $url = $queue\->next) { \& ... \& } .Ve .SS "previous" .IX Subsection "previous" The previous method moves the cursor to the previous loop position and returns the \s-1URL.\s0 .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& while (my $url = $queue\->next) { \& ... \& } \& \& print $queue\->previous; .Ve .SS "first" .IX Subsection "first" The first method moves the cursor to the first loop position and returns the \s-1URL.\s0 .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& print $queue\->first; .Ve .SS "last" .IX Subsection "last" The last method moves the cursor to the last loop position and returns the \s-1URL.\s0 .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& print $queue\->last; .Ve .SS "index" .IX Subsection "index" The index method moves the cursor to the specified loop position and returns the \&\s-1URL.\s0 The loop position is a standard array index position. .PP .Vb 1 \& my $queue = Scrappy::Queue\->new; \& \& $queue\->add(...); \& $queue\->add(...); \& $queue\->add(...); \& \& print $queue\->index(1); .Ve .SS "cursor" .IX Subsection "cursor" The cursor method returns the current loop position. .PP .Vb 2 \& my $queue = Scrappy::Queue\->new; \& print $queue\->cursor; .Ve .SH "AUTHOR" .IX Header "AUTHOR" Al Newkirk .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2010 by awncorp. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.