From: Vincent Bernat <vincent@bernat.im>
Date: Wed, 13 Jun 2018 06:29:46 +0000 (+0200)
Subject: lib: document the inability to do anything else when processing notifications
X-Git-Tag: 1.0.2~18
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=09a267fcda7adf5b0667627d5a7500cbfbec08ac;p=thirdparty%2Flldpd.git

lib: document the inability to do anything else when processing notifications

The code doesn't handle notifications with regular operations on the
same connection. Tell the user to open a another connection.
---

diff --git a/src/lib/lldpctl.h b/src/lib/lldpctl.h
index bb996d9e..45b29f7d 100644
--- a/src/lib/lldpctl.h
+++ b/src/lib/lldpctl.h
@@ -489,6 +489,9 @@ typedef void (*lldpctl_change_callback)(lldpctl_conn_t *conn,
  * This function will register the necessity to push neighbor changes to lldpd
  * and therefore will issue IO operations. The error code could then be @c
  * LLDPCTL_ERR_WOULDBLOCK.
+ *
+ * Once a callback is registered, the connection shouldn't be used for anything
+ * else than receiving notifications.
  */
 int lldpctl_watch_callback(lldpctl_conn_t *conn,
     lldpctl_change_callback cb,