1 /* Copyright (c) 2006-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SIMGRID_S4U_ASYNC_HPP
8 #define SIMGRID_S4U_ASYNC_HPP
13 /* Forward declaration */
17 inited, started, finished
18 } e_s4u_async_state_t;
20 /** @brief Asynchronous Actions
22 * This class is the ancestor of every asynchronous actions, that is, of actions that do take time in the simulated world.
31 smx_synchro_t p_inferior = NULL;
34 e_s4u_async_state_t p_state = inited;
36 /** Starts a previously created async.
38 * This function is optional: you can call wait() even if you didn't call start()
40 virtual void start()=0;
41 /** Tests whether the given async is terminated yet */
42 //virtual bool test()=0;
43 /** Blocks until the async is terminated */
44 virtual void wait()=0;
45 /** Blocks until the async is terminated, or until the timeout is elapsed
46 * Raises: timeout exception.*/
47 virtual void wait(double timeout)=0;
48 /** Cancel that async */
49 //virtual void cancel();
50 /** Retrieve the current state of the async */
51 e_s4u_async_state_t getState() {return p_state;}
56 /** Get the remaining amount of work that this Async entails. When it's 0, it's done. */
58 /** Set the [remaining] amount of work that this Async will entail
60 * It is forbidden to change the amount of work once the Async is started */
61 void setRemains(double remains);
64 void *p_userData = NULL;
66 /** Put some user data onto the Async */
67 void setUserData(void *data) {p_userData=data;}
68 /** Retrieve the user data of the Async */
69 void *getUserData() { return p_userData; }
72 }}; // Namespace simgrid::s4u
74 #endif /* SIMGRID_S4U_ASYNC_HPP */