From a9e604d51df1f30e5423cdb2e5b99cefa2369082 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Mon, 6 Jan 2014 08:59:27 +0100
Subject: event/MultiSocketMonitor: API documentation

---
 src/event/MultiSocketMonitor.hxx | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src')

diff --git a/src/event/MultiSocketMonitor.hxx b/src/event/MultiSocketMonitor.hxx
index 6c76d667f..d6ad3b177 100644
--- a/src/event/MultiSocketMonitor.hxx
+++ b/src/event/MultiSocketMonitor.hxx
@@ -112,6 +112,10 @@ public:
 	using IdleMonitor::GetEventLoop;
 
 public:
+	/**
+	 * Invalidate the socket list.  A call to PrepareSockets() is
+	 * scheduled which will then update the list.
+	 */
 	void InvalidateSockets() {
 		refresh = true;
 		IdleMonitor::Schedule();
@@ -121,6 +125,12 @@ public:
 		fds.emplace_front(*this, fd, events);
 	}
 
+	/**
+	 * Update the known sockets by invoking the given function for
+	 * each one; its return value is the events bit mask.  A
+	 * return value of 0 means the socket will be removed from the
+	 * list.
+	 */
 	template<typename E>
 	void UpdateSocketList(E &&e) {
 		for (auto prev = fds.before_begin(), end = fds.end(),
-- 
cgit v1.2.3