From: Martin Quinson <martin.quinson@loria.fr>
Date: Mon, 2 Oct 2017 21:28:11 +0000 (+0200)
Subject: cosmetics and doc
X-Git-Tag: v3_17~45
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/ca4b3db58538b833f2458a83c174bd32f1705dee

cosmetics and doc
---

diff --git a/src/s4u/s4u_comm.cpp b/src/s4u/s4u_comm.cpp
index abc76c9fc1..bfd0faad7e 100644
--- a/src/s4u/s4u_comm.cpp
+++ b/src/s4u/s4u_comm.cpp
@@ -82,53 +82,42 @@ void Comm::start() {
   }
   state_ = started;
 }
+
+/** @brief Block the calling actor until the communication is finished */
 void Comm::wait() {
-  xbt_assert(state_ == started || state_ == inited || state_ == finished);
-
-  if (state_ == finished)
-    return;
-
-  if (state_ == started)
-    simcall_comm_wait(pimpl_, -1/*timeout*/);
-  else { // state_ == inited. Save a simcall and do directly a blocking send/recv
-    if (srcBuff_ != nullptr) {
-      simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
-          srcBuff_, srcBuffSize_,
-          matchFunction_, copyDataFunction_,
-          userData_, -1 /*timeout*/);
-    } else {
-      simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
-          matchFunction_, copyDataFunction_,
-          userData_, -1/*timeout*/, rate_);
-    }
-  }
-  state_ = finished;
+  this->wait(-1);
 }
 
+/** @brief Block the calling actor until the communication is finished, or until timeout
+ *
+ * On timeout, an exception is thrown.
+ *
+ * @param timeout the amount of seconds to wait for the comm termination.
+ *                Negative values denote infinite wait times. 0 as a timeout returns immediately. */
 void Comm::wait(double timeout) {
-  xbt_assert(state_ == started || state_ == inited || state_ == finished);
-
-  if (state_ == finished)
-    return;
-
-  if (state_ == started) {
-    simcall_comm_wait(pimpl_, timeout);
-    state_ = finished;
-    return;
-  }
-
-  // It's not started yet. Do it in one simcall
-  if (srcBuff_ != nullptr) {
-    simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_,
-        srcBuff_, srcBuffSize_,
-        matchFunction_, copyDataFunction_,
-        userData_, timeout);
-  } else { // Receiver
-    simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_,
-        matchFunction_, copyDataFunction_,
-        userData_, timeout, rate_);
+  switch (state_) {
+    case finished:
+      return;
+
+    case inited: // It's not started yet. Do it in one simcall
+      if (srcBuff_ != nullptr) {
+        simcall_comm_send(sender_, mailbox_->getImpl(), remains_, rate_, srcBuff_, srcBuffSize_, matchFunction_,
+                          copyDataFunction_, userData_, timeout);
+      } else { // Receiver
+        simcall_comm_recv(receiver_, mailbox_->getImpl(), dstBuff_, &dstBuffSize_, matchFunction_, copyDataFunction_,
+                          userData_, timeout, rate_);
+      }
+      state_ = finished;
+      return;
+
+    case started:
+      simcall_comm_wait(pimpl_, timeout);
+      state_ = finished;
+      return;
+
+    default:
+      THROW_IMPOSSIBLE;
   }
-  state_ = finished;
 }
 
 void Comm::detach()