simgrid::s4u::this_actor::exit();
}
-/** @ingroup m_actor_management
+/**
* @brief Returns the process ID of @a actor.
*
* This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
return actor->get_pid();
}
-/** @ingroup m_actor_management
+/**
* @brief Returns the process ID of the parent of @a actor.
*
* This function checks whether @a actor is a valid pointer and return its parent's PID.
return actor->get_ppid();
}
-/** @ingroup m_actor_management
- *
+/**
* @brief Return a #sg_actor_t given its PID.
*
* This function search in the list of all the created sg_actor_t for a sg_actor_t whose PID is equal to @a PID.
return simgrid::s4u::Actor::by_pid(pid).get();
}
-/** @ingroup m_actor_management
- * @brief Return the name of an actor.
- */
+/** @brief Return the name of an actor. */
const char* sg_actor_get_name(const_sg_actor_t actor)
{
return actor->get_cname();
return actor->get_host();
}
-/** @ingroup m_actor_management
+/**
* @brief Returns the value of a given actor property
*
* @param actor an actor
return actor->get_property(name);
}
-/** @ingroup m_actor_management
+/**
* @brief Return the list of properties
*
* This function returns all the parameters associated with an actor
return as_dict;
}
-/** @ingroup m_actor_management
+/**
* @brief Suspend the actor.
*
* This function suspends the actor by suspending the task on which it was waiting for the completion.
actor->suspend();
}
-/** @ingroup m_actor_management
+/**
* @brief Resume a suspended actor.
*
* This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
actor->resume();
}
-/** @ingroup m_actor_management
+/**
* @brief Returns true if the actor is suspended .
*
* This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
return actor->is_suspended();
}
-/**
- * @ingroup m_actor_management
- * @brief Restarts an actor from the beginning.
- */
+/** @brief Restarts an actor from the beginning. */
sg_actor_t sg_actor_restart(sg_actor_t actor)
{
return actor->restart();
}
/**
- * @ingroup m_actor_management
* @brief Sets the "auto-restart" flag of the actor.
* If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
*/
actor->set_auto_restart(auto_restart);
}
-/** @ingroup m_actor_management
- * @brief This actor will be terminated automatically when the last non-daemon actor finishes
- */
+/** @brief This actor will be terminated automatically when the last non-daemon actor finishes */
void sg_actor_daemonize(sg_actor_t actor)
{
actor->daemonize();
}
-/** @ingroup m_actor_management
+/**
* @brief Migrates an actor to another location.
*
* This function changes the value of the #sg_host_t on which @a actor is running.
process->set_host(host);
}
-/** @ingroup m_actor_management
+/**
* @brief Wait for the completion of a #sg_actor_t.
*
* @param actor the actor to wait for
simgrid::s4u::Actor::kill_all();
}
-/** @ingroup m_actor_management
+/**
* @brief Set the kill time of an actor.
*
* @param actor an actor