summaryrefslogtreecommitdiff
path: root/libgps.xml
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2011-10-03 16:24:22 -0400
committerEric S. Raymond <esr@thyrsus.com>2011-10-03 16:24:22 -0400
commitb56676a7b50c313e4b3907edf77c4c34c74d3cdb (patch)
treed543965a1ff37951a1621d3aa8819859c657ba78 /libgps.xml
parentfcb7a28e5a7b37e5704e1800bc482c2d76cd188e (diff)
downloadgpsd-b56676a7b50c313e4b3907edf77c4c34c74d3cdb.tar.gz
The shm export gets a waiting method.
Diffstat (limited to 'libgps.xml')
-rw-r--r--libgps.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/libgps.xml b/libgps.xml
index 77ec6e96..e094de1e 100644
--- a/libgps.xml
+++ b/libgps.xml
@@ -142,15 +142,15 @@ socket to the daemon has closed or if the shared-memory segment was
unavailable, and 0 if no data is available.</para>
<para><function>gps_waiting()</function> can be used to check whether
-there is data from the daemon (it always returns true when using the
-shared-memory export). The second argument is the maximum amount of
-time to wait (in microseconds) on input before returning. It returns
-true if there input waiting, false on timeout (no data waiting) or
-error condition. This function is a convenience wrapper around a
+there is new data from the daemon. The second argument is the maximum
+amount of time to wait (in microseconds) on input before returning.
+It returns true if there is input waiting, false on timeout (no data
+waiting) or error condition. This function is a convenience wrapper
+around a
<citerefentry><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry>
call, and zeros <varname>errno</varname> on entry; you can test
<varname>errno</varname> after exit to get more information about
-error conditions. The timeout value is in microseconds.</para>
+error conditions.</para>
<para><function>gps_unpack()</function> parses JSON from the argument
buffer into the target of the session structure pointer argument.