GpgFrontend/vmime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed and clarified text about handleTimeout() return value.

Browse Source
This commit is contained in:
Vincent Richard 2013-03-13 17:47:47 +01:00
parent 742917a382
commit 7550835f47
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/book/net.tex
View File

@ -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: