| … | |
… | |
| 247 | many seconds pass without a successful read or write on the underlying |
247 | many seconds pass without a successful read or write on the underlying |
| 248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
248 | file handle (or a call to C<timeout_reset>), the C<on_timeout> callback |
| 249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
249 | will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT> |
| 250 | error will be raised). |
250 | error will be raised). |
| 251 | |
251 | |
| 252 | There are three variants of the timeouts that work independently |
252 | There are three variants of the timeouts that work independently of each |
| 253 | of each other, for both read and write, just read, and just write: |
253 | other, for both read and write (triggered when nothing was read I<OR> |
|
|
254 | written), just read (triggered when nothing was read), and just write: |
| 254 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
255 | C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks |
| 255 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
256 | C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions |
| 256 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
257 | C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>. |
| 257 | |
258 | |
| 258 | Note that timeout processing is active even when you do not have |
259 | Note that timeout processing is active even when you do not have any |
| 259 | any outstanding read or write requests: If you plan to keep the connection |
260 | outstanding read or write requests: If you plan to keep the connection |
| 260 | idle then you should disable the timeout temporarily or ignore the timeout |
261 | idle then you should disable the timeout temporarily or ignore the |
| 261 | in the C<on_timeout> callback, in which case AnyEvent::Handle will simply |
262 | timeout in the corresponding C<on_timeout> callback, in which case |
| 262 | restart the timeout. |
263 | AnyEvent::Handle will simply restart the timeout. |
| 263 | |
264 | |
| 264 | Zero (the default) disables this timeout. |
265 | Zero (the default) disables the corresponding timeout. |
| 265 | |
266 | |
| 266 | =item on_timeout => $cb->($handle) |
267 | =item on_timeout => $cb->($handle) |
|
|
268 | |
|
|
269 | =item on_rtimeout => $cb->($handle) |
|
|
270 | |
|
|
271 | =item on_wtimeout => $cb->($handle) |
| 267 | |
272 | |
| 268 | Called whenever the inactivity timeout passes. If you return from this |
273 | Called whenever the inactivity timeout passes. If you return from this |
| 269 | callback, then the timeout will be reset as if some activity had happened, |
274 | callback, then the timeout will be reset as if some activity had happened, |
| 270 | so this condition is not fatal in any way. |
275 | so this condition is not fatal in any way. |
| 271 | |
276 | |
| … | |
… | |
| 778 | =item $handle->rtimeout ($seconds) |
783 | =item $handle->rtimeout ($seconds) |
| 779 | |
784 | |
| 780 | =item $handle->wtimeout ($seconds) |
785 | =item $handle->wtimeout ($seconds) |
| 781 | |
786 | |
| 782 | Configures (or disables) the inactivity timeout. |
787 | Configures (or disables) the inactivity timeout. |
|
|
788 | |
|
|
789 | The timeout will be checked instantly, so this method might destroy the |
|
|
790 | handle before it returns. |
| 783 | |
791 | |
| 784 | =item $handle->timeout_reset |
792 | =item $handle->timeout_reset |
| 785 | |
793 | |
| 786 | =item $handle->rtimeout_reset |
794 | =item $handle->rtimeout_reset |
| 787 | |
795 | |
