about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2017-07-09 07:46:23 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2017-07-09 07:46:23 +0000
commit22a1dc61ef8e4e1c98e3a088db1dbc84d424c7a7 (patch)
treeefc5d779a40c004e708bd6a99b359c660931249b /doc
parent0c9b6b3625dff03b6d590af597aa0f194790addb (diff)
downloadbcnm-22a1dc61ef8e4e1c98e3a088db1dbc84d424c7a7.tar.gz
bcnm-22a1dc61ef8e4e1c98e3a088db1dbc84d424c7a7.tar.xz
bcnm-22a1dc61ef8e4e1c98e3a088db1dbc84d424c7a7.zip
Separate messages via \0, read messages one by one. Add wpactrl_scan_parse() skel.
Diffstat (limited to 'doc')
-rw-r--r--doc/libwpactrl/index.html24
1 files changed, 9 insertions, 15 deletions
diff --git a/doc/libwpactrl/index.html b/doc/libwpactrl/index.html
index 0d2870e..1115787 100644
--- a/doc/libwpactrl/index.html
+++ b/doc/libwpactrl/index.html
@@ -175,24 +175,18 @@ a spamming wpa_supplicant from monopolizing your program.
 </p>
 
 <p>
-<code> char *wpactrl_data (wpactrl_t *a) </code> <br />
-Returns a pointer to the unsolicited messages from wpa_supplicant
-that have been read by <tt>wpactrl_update()</tt> but haven't been
-acknowledged yet.
+<code> char *wpactrl_msg (wpactrl_t *a) </code> <br />
+Returns a pointer to the first unsolicited message from
+wpa_supplicant that has been read by <tt>wpactrl_update()</tt> but
+has not been acknowledged yet. If there's no such message,
+returns NULL.
 </p>
 
 <p>
-<code> char *wpactrl_datalen (wpactrl_t *a) </code> <br />
-Returns the length of unsolicited messages from wpa_supplicant
-that have been read by <tt>wpactrl_update()</tt> but haven't been
-acknowledged yet.
-</p>
-
-<p>
-<code> void wpactrl_ackdata (wpactrl_t *a) </code>
-Acknowledges reading the latest batch of unsolicited messages
-from wpa_supplicant: allows the next invocation of
-<tt>wpactrl_update()</tt> to reuse the storage.
+<code> void wpactrl_nextmsg (wpactrl_t *a) </code> <br />
+Acknowledges reading of one unsolicited message from wpa_supplicant.
+The next invocation of <tt>wpactrl_msg()</tt> will point to the next
+one.
 </p>
 
 <p>