[3/3] mesos git commit: Documented when to invoke `send` using the scheduler library.

[vi...@apache.org]

Documented when to invoke `send` using the scheduler library.

Trivial change to add a comment to invoke `send` only after
receiving the `connected` callback. If not, all calls would
be dropped while disconnected.

Review: https://reviews.apache.org/r/45410/


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/c6d61822
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/c6d61822
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/c6d61822

Branch: refs/heads/master
Commit: c6d6182223816607038b76f57ece2e1453f82d8b
Parents: bae4f13
Author: Anand Mazumdar <ma...@gmail.com>
Authored: Wed Mar 30 12:00:35 2016 -0700
Committer: Vinod Kone <vi...@gmail.com>
Committed: Wed Mar 30 12:00:35 2016 -0700

----------------------------------------------------------------------
 include/mesos/v1/scheduler.hpp | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/c6d61822/include/mesos/v1/scheduler.hpp
----------------------------------------------------------------------
diff --git a/include/mesos/v1/scheduler.hpp b/include/mesos/v1/scheduler.hpp
index bfc54c7..5264732 100644
--- a/include/mesos/v1/scheduler.hpp
+++ b/include/mesos/v1/scheduler.hpp
@@ -47,7 +47,9 @@ class MesosProcess; // Forward declaration.
 // 'received' which will get invoked _serially_ when it's determined
 // that we've connected (i.e., detected master), disconnected
 // (i.e, detected no master), or received events from the master.
-// Note that we drop events while disconnected.
+// The library reconnects with the master upon a disconnection.
+//
+// NOTE: All calls and events are dropped while disconnected.
 class Mesos
 {
 public:
@@ -67,6 +69,10 @@ public:
 
   // Attempts to send a call to the master.
   //
+  // The scheduler should only invoke this method once it has received the
+  // 'connected' callback. Otherwise, all calls would be dropped while
+  // disconnected.
+  //
   // Some local validation of calls is performed which may generate
   // events without ever being sent to the master. This includes when
   // calls are sent but no master is currently detected (i.e., we're