.\" 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 "Tirex::Manager::RenderingJobs 3pm" .TH Tirex::Manager::RenderingJobs 3pm "2021-10-07" "perl v5.32.1" "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" Tirex::Manager::Rendering \- Hold currently rendering jobs .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Tirex::Manager:RenderingJobs; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Keeps the list of currently rendering jobs. .SH "METHODS" .IX Header "METHODS" .SS "Tirex::Manager::RenderingJobs\->new( timeout => 120 )" .IX Subsection "Tirex::Manager::RenderingJobs->new( timeout => 120 )" Create new object. .ie n .SS "$rj\->\fBcount()\fP" .el .SS "\f(CW$rj\fP\->\fBcount()\fP" .IX Subsection "$rj->count()" Returns the number of jobs currently rendering. .ie n .SS "$rj\->add($job)" .el .SS "\f(CW$rj\fP\->add($job)" .IX Subsection "$rj->add($job)" Add a job. Returns the job added. .ie n .SS "$rj\->remove($job)" .el .SS "\f(CW$rj\fP\->remove($job)" .IX Subsection "$rj->remove($job)" Remove a job. Returns the job removed. .ie n .SS "$rj\->find_by_id($id)" .el .SS "\f(CW$rj\fP\->find_by_id($id)" .IX Subsection "$rj->find_by_id($id)" Find a currently rendering job by its id. .ie n .SS "$rj\->find_by_metatile($hash)" .el .SS "\f(CW$rj\fP\->find_by_metatile($hash)" .IX Subsection "$rj->find_by_metatile($hash)" Find a currently rendering job for some metatile by the metatile hash. .ie n .SS "$rj\->\fBcheck_timeout()\fP" .el .SS "\f(CW$rj\fP\->\fBcheck_timeout()\fP" .IX Subsection "$rj->check_timeout()" Check if there are any jobs older than the timeout and remove them. They will have been killed by tirex-backend-manager in the mean time. .PP Returns the number of jobs removed. .ie n .SS "$rj\->\fBstatus()\fP" .el .SS "\f(CW$rj\fP\->\fBstatus()\fP" .IX Subsection "$rj->status()" Return status.