include/simgrid/activity_set.h

   1 /* Copyright (c) 2018-2023. 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 INCLUDE_SIMGRID_ACTIVITY_SET_H
   7 #define INCLUDE_SIMGRID_ACTIVITY_SET_H
   8
   9 #include <simgrid/forward.h>
  10 #include <sys/types.h> /* ssize_t */
  11
  12 /* C interface */
  13 SG_BEGIN_DECL
  14
  15 XBT_PUBLIC sg_activity_set_t sg_activity_set_init();
  16 XBT_PUBLIC void sg_activity_set_push(sg_activity_set_t as, sg_activity_t acti);
  17 XBT_PUBLIC void sg_activity_set_erase(sg_activity_set_t as, sg_activity_t acti);
  18 XBT_PUBLIC size_t sg_activity_set_size(sg_activity_set_t as);
  19 XBT_PUBLIC int sg_activity_set_empty(sg_activity_set_t as);
  20
  21 XBT_PUBLIC sg_activity_t sg_activity_set_test_any(sg_activity_set_t as);
  22 XBT_PUBLIC void sg_activity_set_wait_all(sg_activity_set_t as);
  23 /** Returns true if it terminated successfully (or false on timeout) */
  24 XBT_PUBLIC int sg_activity_set_wait_all_for(sg_activity_set_t as, double timeout);
  25 XBT_PUBLIC sg_activity_t sg_activity_set_wait_any(sg_activity_set_t as);
  26 XBT_PUBLIC sg_activity_t sg_activity_set_wait_any_for(sg_activity_set_t as, double timeout);
  27 XBT_PUBLIC void sg_activity_set_delete(sg_activity_set_t as);
  28
  29 /** You must call this function manually on activities extracted from an activity_set with waitany and friends */
  30 XBT_PUBLIC void sg_activity_unref(sg_activity_t acti);
  31
  32 SG_END_DECL
  33
  34 #endif /* INCLUDE_SIMGRID_ACTIVITY_SET_H */