From Hauke Mehrtens via https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8567

[metze/wireshark/wip.git] / iface_monitor.h

diff --git a/iface_monitor.h b/iface_monitor.h
index 88bd0a19d8aeafdd0d976d6f3842149ce29e3eb0..a24c93ef4e94512eea38d1ebbdf3166f4d5af05a 100644 (file)
--- a/iface_monitor.h
+++ b/iface_monitor.h
@@ -19,23 +19,56 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 #ifndef IFACE_MONITOR_H
 #define IFACE_MONITOR_H
 
 #ifdef HAVE_LIBPCAP
 
+/*
+ * Callback for interface changes.
+ *
+ * iface is a pointer to the name of the interface.
+ *
+ * up is 1 if the interface is up, 0 if it's down.
+ *
+ * XXX - we really want "gone", not "down", where "gone" may include
+ * "down" if the OS requires an interface to be up in order to start
+ * a capture on it (as is the case in Linux and in OS X prior to
+ * Lion), but should also include *gone*, as in "there is no longer
+ * an interface with this name, so it's neither down nor up".
+ *
+ * We also may want other events, such as address changes, so what
+ * we might want is "add", "remove", and "modify" as the events.
+ */
 typedef void (*iface_mon_cb)(const char *iface, int up);
+
+/*
+ * Start watching for interface changes.
+ */
 int
 iface_mon_start(iface_mon_cb cb);
 
+/*
+ * Stop watching for interface changes.
+ */
 void
 iface_mon_stop(void);
 
+/*
+ * Get the socket on which interface changes are delivered, so that
+ * we can add it to the event loop.
+ *
+ * XXX - what if it's not a socket or other file descriptor?
+ */
 int
 iface_mon_get_sock(void);
 
+/*
+ * Call this if something is readable from the interface change socket.
+ * It will call the callback as appropriate.
+ */
 void
 iface_mon_event(void);