From 71d09400f76a34c3f186b62d01e4fd496d888441 Mon Sep 17 00:00:00 2001
From: "benjamin.franksen" <benjamin.franksen@helmholtz-berlin.de>
Date: Mon, 9 Sep 2013 22:21:40 +0000
Subject: [PATCH] documented extra timeout argument for pvGet and pvPut
---
documentation/Reference.txt | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/documentation/Reference.txt b/documentation/Reference.txt
index c9b157ff..d23cea2a 100644
--- a/documentation/Reference.txt
+++ b/documentation/Reference.txt
@@ -1141,6 +1141,7 @@ pvPut
.. c:function::
pvStat pvPut(assigned_var)
pvStat pvPut(assigned_var, SYNC)
+ pvStat pvPut(assigned_var, SYNC, timeout)
pvStat pvPut(assigned_var, ASYNC)
Puts (or writes) the value of an SNL variable to the underlying process
@@ -1195,6 +1196,12 @@ clause.
Note that for anonymous PVs completion is always immediate, so the ``ASYNC`` option
is not very useful.
+.. versionadded:: 2.2
+
+A timeout value may be specified after the ``SYNC`` argument. This should be
+a positive floating point number, specifying the number of seconds before
+the request times out. This value overrides the default timeout of 10 seconds.
+
pvPutComplete
^^^^^^^^^^^^^
@@ -1236,6 +1243,7 @@ pvGet
.. c:function::
pvStat pvGet(assigned_var)
pvStat pvGet(assigned_var, SYNC)
+ pvStat pvGet(assigned_var, SYNC, timeout)
pvStat pvGet(assigned_var, ASYNC)
Gets (or reads) the value of an SNL variable from the underlying process
@@ -1264,6 +1272,12 @@ until a call to pvGetComplete is made and returns ``TRUE`` or, if the
variable is monitored, until the state set waits for events in a :token:`when`
clause. Note that anonymous PVs behave exactly in the same way.
+.. versionadded:: 2.2
+
+A timeout value may be specified after the ``SYNC`` argument. This should be
+a positive floating point number, specifying the number of seconds before
+the request times out. This value overrides the default timeout of 10 seconds.
+
pvGetComplete
^^^^^^^^^^^^^
--
GitLab