monclient: document get_version(), and fix return value

Return -EAGAIN instead of -1, since that's more meaningful, and
document it.

Signed-off-by: Sage Weil <sage@inktank.com>

diff --git a/src/mon/MonClient.cc b/src/mon/MonClient.cc
index 61e8004a49dc4f45e1811362e5dc5b1bfdaab0aa..62f0e9d7484c629109604d9f25dfab01b2c26f0b 100644 (file)
--- a/src/mon/MonClient.cc
+++ b/src/mon/MonClient.cc
@@ -481,7 +481,7 @@ void MonClient::_reopen_session()
 
   // throw out version check requests
   while (!version_requests.empty()) {
-    finisher.queue(version_requests.begin()->second->context, -1);
+    finisher.queue(version_requests.begin()->second->context, -EAGAIN);
     version_requests.erase(version_requests.begin());
   }
 

diff --git a/src/mon/MonClient.h b/src/mon/MonClient.h
index 434f7b1d662d1d852c7b7c249b2068b7ba76bed0..d56d3ec31e15dccb69834620e5adc9e143183abc 100644 (file)
--- a/src/mon/MonClient.h
+++ b/src/mon/MonClient.h
@@ -246,6 +246,16 @@ public:
   // version requests
 public:
   void is_latest_map(string map, version_t cur_ver, Context *onfinish);
+
+  /**
+   * get latest known version(s) of cluster map
+   *
+   * @param map string name of map (e.g., 'osdmap')
+   * @param newest pointer where newest map version will be stored
+   * @param oldest pointer where oldest map version will be stored
+   * @param onfinish context that will be triggered on completion
+   * @return (via context) 0 on success, -EAGAIN if we need to resubmit our request
+   */
   void get_version(string map, version_t *newest, version_t *oldest, Context *onfinish);
 
 private: