.\" 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 "Out 3pm"
.TH Out 3pm "2021-01-03" "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"
Time::Out \- Easily timeout long running operations
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Time::Out qw(timeout) ;
\&
\&  timeout $nb_secs => sub {
\&    # your code goes were and will be interrupted if it runs
\&    # for more than $nb_secs seconds.
\&  } ;
\&  if ($@){
\&    # operation timed\-out
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Time::Out\*(C'\fR provides an easy interface to \fI\f(BIalarm\fI\|(2)\fR based timeouts. 
Nested timeouts are supported.
.SS "\s-1RETURN VALUE\s0"
.IX Subsection "RETURN VALUE"
\&'timeout' returns whatever the code placed inside the block returns:
.PP
.Vb 1
\&  use Time::Out qw(timeout) ;
\&
\&  my $rc = timeout 5 => sub {
\&        return 7 ;
\&  } ;
\&  # $rc == 7
.Ve
.ie n .SH """Time::HiRes"""
.el .SH "\f(CWTime::HiRes\fP"
.IX Header "Time::HiRes"
If \f(CW\*(C`Time::Out\*(C'\fR sees that \f(CW\*(C`Time::HiRes\*(C'\fR has been loaded, it will use 
that 'alarm' function (if available) instead of the default one, allowing 
float timeout values to be used effectively:
.PP
.Vb 2
\&  use Time::Out ;
\&  use Time::HiRes ;
\&
\&  timeout 3.1416 => sub {
\&        # ...
\&  } ;
.Ve
.SH "BUGS"
.IX Header "BUGS"
.IP "Blocking I/O on MSWin32" 4
.IX Item "Blocking I/O on MSWin32"
\&\fI\f(BIalarm\fI\|(2)\fR doesn't interrupt blocking I/O on MSWin32, so 'timeout' won't
do that either.
.ie n .IP "@_" 4
.el .IP "\f(CW@_\fR" 4
.IX Item "@_"
One drawback to using 'timeout' is that it masks \f(CW@_\fR in the affected code. 
This happens because the affected code is actually wrapped inside another 
subroutine that provides it's own \f(CW@_\fR. You can get around this by 
specifically passing your \f(CW@_\fR (or whatever you want for that matter) to 
\&'timeout' as such:
.Sp
.Vb 1
\&  use Time::Out ;
\&
\&  sub test {
\&    timeout 5, @_ => sub {
\&      print "$_[0]\en" ;
\&    } ;
\&  }
\&
\&  test("hello") ; # will print "hello\en" ;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
eval, closures, \fI\f(BIalarm\fI\|(2)\fR, Sys::AlarmCall
.SH "AUTHOR"
.IX Header "AUTHOR"
Patrick LeBoutillier, <patl@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2005\-2008 by Patrick LeBoutillier
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.