Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
uppercase the s4u header files (+cleanups)
[simgrid.git] / include / simgrid / s4u / Comm.hpp
similarity index 72%
rename from include/simgrid/s4u/comm.hpp
rename to include/simgrid/s4u/Comm.hpp
index 239755e..2a49c55 100644 (file)
@@ -8,31 +8,30 @@
 
 #include <xbt/base.h>
 
+#include <simgrid/forward.h>
 #include <simgrid/s4u/Activity.hpp>
 #include <simgrid/s4u/forward.hpp>
-#include <simgrid/forward.h>
-
 
 namespace simgrid {
 namespace s4u {
 
-
 /** @brief Communication async
  *
  * Represents all asynchronous communications, that you can test or wait onto.
  */
-XBT_PUBLIC_CLASS Comm : public Activity {
+XBT_PUBLIC_CLASS Comm : public Activity
+{
   Comm() : Activity() {}
 public:
   ~Comm() override;
 
-  /*! take a range of s4u::Comm* (last excluded) and return when one of them is finished. The return value is an iterator on the finished Comms. */
-  template<class I> static
-  I wait_any(I first, I last)
+  /*! take a range of s4u::Comm* (last excluded) and return when one of them is finished. The return value is an
+   * iterator on the finished Comms. */
+  template <class I> static I wait_any(I first, I last)
   {
     // Map to dynar<Synchro*>:
     xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
-    for(I iter = first; iter != last; iter++) {
+    for (I iter = first; iter != last; iter++) {
       Comm& comm = **iter;
       if (comm.state_ == inited)
         comm.start();
@@ -46,17 +45,16 @@ public:
     if (idx == -1)
       return last;
     // Lift the index to the corresponding iterator:
-    auto res = std::next(first, idx);
+    auto res       = std::next(first, idx);
     (*res)->state_ = finished;
     return res;
   }
   /*! Same as wait_any, but with a timeout. If wait_any_for return because of the timeout last is returned.*/
-  template<class I> static
-  I wait_any_for(I first, I last, double timeout)
+  template <class I> static I wait_any_for(I first, I last, double timeout)
   {
     // Map to dynar<Synchro*>:
     xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
-    for(I iter = first; iter != last; iter++) {
+    for (I iter = first; iter != last; iter++) {
       Comm& comm = **iter;
       if (comm.state_ == inited)
         comm.start();
@@ -70,18 +68,18 @@ public:
     if (idx == -1)
       return last;
     // Lift the index to the corresponding iterator:
-    auto res = std::next(first, idx);
+    auto res       = std::next(first, idx);
     (*res)->state_ = finished;
     return res;
   }
   /** Creates (but don't start) an async send to the mailbox @p dest */
-  static Comm &send_init(MailboxPtr dest);
+  static Commsend_init(MailboxPtr dest);
   /** Creates and start an async send to the mailbox @p dest */
-  static Comm &send_async(MailboxPtr dest, void *data, int simulatedByteAmount);
-    /** Creates (but don't start) an async recv onto the mailbox @p from */
-  static Comm &recv_init(MailboxPtr from);
+  static Comm& send_async(MailboxPtr dest, void* data, int simulatedByteAmount);
+  /** Creates (but don't start) an async recv onto the mailbox @p from */
+  static Commrecv_init(MailboxPtr from);
   /** Creates and start an async recv to the mailbox @p from */
-  static Comm &recv_async(MailboxPtr from, void **data);
+  static Comm& recv_async(MailboxPtr from, void** data);
 
   void start() override;
   void wait() override;
@@ -91,40 +89,39 @@ public:
   void setRate(double rate);
 
   /** Specify the data to send */
-  void setSrcData(void * buff);
+  void setSrcData(void* buff);
   /** Specify the size of the data to send */
   void setSrcDataSize(size_t size);
   /** Specify the data to send and its size */
-  void setSrcData(void * buff, size_t size);
+  void setSrcData(void* buff, size_t size);
 
   /** Specify where to receive the data */
-  void setDstData(void ** buff);
+  void setDstData(void** buff);
   /** Specify the buffer in which the data should be received */
-  void setDstData(void ** buff, size_t size);
+  void setDstData(void** buff, size_t size);
   /** Retrieve the size of the received data */
   size_t getDstDataSize();
 
   bool test();
 
-
 private:
-  double rate_ = -1;
-  void *dstBuff_ = nullptr;
+  double rate_        = -1;
+  void* dstBuff_      = nullptr;
   size_t dstBuffSize_ = 0;
-  void *srcBuff_ = nullptr;
+  void* srcBuff_      = nullptr;
   size_t srcBuffSize_ = sizeof(void*);
 
   /* FIXME: expose these elements in the API */
   int detached_ = 0;
-  int (*matchFunction_)(void *, void *, smx_activity_t) = nullptr;
-  void (*cleanFunction_)(void *) = nullptr;
+  int (*matchFunction_)(void*, void*, smx_activity_t) = nullptr;
+  void (*cleanFunction_)(void*) = nullptr;
   void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;
 
-  smx_actor_t sender_ = nullptr;
+  smx_actor_t sender_   = nullptr;
   smx_actor_t receiver_ = nullptr;
-  MailboxPtr mailbox_ = nullptr;
+  MailboxPtr mailbox_   = nullptr;
 };
-
-}} // namespace simgrid::s4u
+}
+} // namespace simgrid::s4u
 
 #endif /* SIMGRID_S4U_COMM_HPP */