diff options
author | Vincent Richard <[email protected]> | 2013-03-13 16:47:47 +0000 |
---|---|---|
committer | Vincent Richard <[email protected]> | 2013-03-13 16:47:47 +0000 |
commit | 7550835f47ab1637966f802f2d0ff99cc63dd761 (patch) | |
tree | 611ddc39783856a22dc1fe9b1c0b62c662b3dce8 | |
parent | Rewrote text for better understanding. (diff) | |
download | vmime-7550835f47ab1637966f802f2d0ff99cc63dd761.tar.gz vmime-7550835f47ab1637966f802f2d0ff99cc63dd761.zip |
Fixed and clarified text about handleTimeout() return value.
-rw-r--r-- | doc/book/net.tex | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/book/net.tex b/doc/book/net.tex index 52ba665a..7653b48e 100644 --- a/doc/book/net.tex +++ b/doc/book/net.tex @@ -703,9 +703,11 @@ class timeoutHandler : public object While the operation runs, the service calls {\vcode isTimeout()} at variable intervals. If the {\vcode isTimeout()} function returns {\vcode true}, then {\vcode handleTimeout()} is called. If the {\vcode handleTimeout()} -function also returns {\vcode true}, the -operation is cancelled and an {\vcode operation\_timed\_out} exception is -thrown. The function {\vcode resetTimeout()} is called each time data has +function returns {\vcode false}, the operation is cancelled and +an {\vcode operation\_timed\_out} exception is thrown. Else, if +{\vcode handleTimeout()} returns true, the operation continues and the +time-out count is reset. +The function {\vcode resetTimeout()} is called each time data has been received from the server to reset time-out delay. The following example shows how to implement a simple time-out handler: |