cleanups and uniformization in Activity headers

[simgrid.git] / include / simgrid / s4u / Io.hpp

diff --git a/include/simgrid/s4u/Io.hpp b/include/simgrid/s4u/Io.hpp
index 6052171..2b82161 100644 (file)
--- a/include/simgrid/s4u/Io.hpp
+++ b/include/simgrid/s4u/Io.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -14,33 +14,47 @@
 namespace simgrid {
 namespace s4u {
 
+/** I/O Activity, representing the asynchronous disk access.
+ *
+ * They are generated from Storage::io_init() or Storage::read() and Storage::write().
+ */
+
 class XBT_PUBLIC Io : public Activity {
-  explicit Io(sg_size_t size) : Activity(), size_(size) {}
+public:
+  enum class OpType { READ, WRITE };
+
+private:
+  Storage* storage_ = nullptr;
+  sg_size_t size_   = 0;
+  OpType type_      = OpType::READ;
+  std::string name_ = "";
+  std::atomic_int_fast32_t refcount_{0};
+
+  explicit Io(sg_storage_t storage, sg_size_t size, OpType type);
+
 public:
   friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Io* i);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Io* i);
-  friend Storage; // Factory of IOs
+  friend simgrid::s4u::Storage; // Factory of IOs
 
-  enum class OpType { READ, WRITE };
   ~Io() = default;
 
-  Activity* start() override;
-  Activity* wait() override;
-  Activity* wait(double timeout) override;
-  Activity* cancel() override;
+  Io* start() override;
+  Io* wait() override;
+  Io* wait_for(double timeout) override;
+  Io* cancel() override;
+  bool test() override;
 
   double get_remaining() override;
   sg_size_t get_performed_ioops();
-  IoPtr set_io_type(OpType type);
+
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v324("Please use Io::wait_for()") void wait(double t) override { wait_for(t); }
+#endif
 
 private:
-  sg_size_t size_       = 0;
-  sg_storage_t storage_ = nullptr;
-  std::string name_     = "";
-  OpType type_          = OpType::READ;
-  std::atomic_int_fast32_t refcount_{0};
 }; // class
-}
-}; // Namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_IO_HPP */