include/simgrid/s4u/Io.hpp

   1 /* Copyright (c) 2017-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_IO_HPP
   7 #define SIMGRID_S4U_IO_HPP
   8
   9 #include <simgrid/forward.h>
  10 #include <simgrid/s4u/Activity.hpp>
  11
  12 #include <string>
  13
  14 namespace simgrid {
  15 namespace s4u {
  16
  17 /** I/O Activity, representing the asynchronous disk access.
  18  *
  19  * They are generated from Disk::io_init(), Disk::read() Disk::read_async(), Disk::write() and Disk::write_async().
  20  */
  21
  22 class XBT_PUBLIC Io : public Activity_T<Io> {
  23 #ifndef DOXYGEN
  24   friend Disk;    // Factory of IOs
  25 #endif
  26   Io();
  27
  28 public:
  29   enum class OpType { READ, WRITE };
  30
  31   static xbt::signal<void(Io const&)> on_start;
  32   static xbt::signal<void(Io const&)> on_completion;
  33
  34   static IoPtr init();
  35   Io* start() override;
  36   Io* wait() override;
  37   Io* wait_for(double timeout) override;
  38   Io* cancel() override;
  39
  40   double get_remaining() const override;
  41   sg_size_t get_performed_ioops() const;
  42   IoPtr set_disk(const_sg_disk_t disk);
  43   IoPtr set_size(sg_size_t size);
  44   IoPtr set_op_type(OpType type);
  45
  46   bool is_assigned() const override;
  47 };
  48
  49 } // namespace s4u
  50 } // namespace simgrid
  51
  52 #endif /* SIMGRID_S4U_IO_HPP */