Skip to content

Commit

Permalink
[core] Update documentation about the parallel execution behavior of …
Browse files Browse the repository at this point in the history
…the spawning functions.

Signed-off-by: Stéphane Galland <galland@arakhne.org>
  • Loading branch information
gallandarakhneorg committed Jan 25, 2018
1 parent 9723dbb commit 574c8e4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions main/apiplugins/io.sarl.core/src/io/sarl/core/bic.sarl
Expand Up @@ -363,6 +363,10 @@ capacity Lifecycle {
* This action must automatically register the newly created agent
* within the default space of the context.
*
* <p>Caution: when this function returns, it replies the UUID of the spawned agent.
* But, there is no warranty that the agent with this id is initialized at the time of the return.
* Indeed, agent spawning is done in parallel to the calling thread.
*
* <p>This function does nothing if one of the following conditions evaluates to true:
* <ul>
* <li>the agent is not alive.</li>
Expand All @@ -381,6 +385,10 @@ capacity Lifecycle {
* This action must automatically register the newly created agents
* within the default space of the context.
*
* <p>Caution: when this function returns, it replies the UUIDs of the spawned agents.
* But, there is no warranty that the agents with th ids are initialized at the time of the return.
* Indeed, agent spawning is done in parallel to the calling thread.
*
* <p>This function does nothing if one of the following conditions evaluates to true:
* <ul>
* <li>the agent is not alive.</li>
Expand All @@ -399,6 +407,10 @@ capacity Lifecycle {
/**
* Spawns a new member agent in the parent's context (parentID).
*
* <p>Caution: when this function returns, it replies the UUID of the spawned agent.
* But, there is no warranty that the agent with this id is initialized at the time of the return.
* Indeed, agent spawning is done in parallel to the calling thread.
*
* <p>This function does nothing if one of the following conditions evaluates to true:
* <ul>
* <li>the agent is not alive.</li>
Expand All @@ -415,6 +427,10 @@ capacity Lifecycle {
/**
* Spawns a group of agents in the parent's context (parentID).
*
* <p>Caution: when this function returns, it replies the UUIDs of the spawned agents.
* But, there is no warranty that the agents with th ids are initialized at the time of the return.
* Indeed, agent spawning is done in parallel to the calling thread.
*
* <p>This function does nothing if one of the following conditions evaluates to true:
* <ul>
* <li>the agent is not alive.</li>
Expand All @@ -434,6 +450,10 @@ capacity Lifecycle {
/**
* Spawns a new member agent in the parent's context (parentID).
*
* <p>Caution: when this function returns, it replies the UUID of the spawned agent.
* But, there is no warranty that the agent with this id is initialized at the time of the return.
* Indeed, agent spawning is done in parallel to the calling thread.
*
* <p>This function does nothing if one of the following conditions evaluates to true:
* <ul>
* <li>the agent is not alive.</li>
Expand Down

0 comments on commit 574c8e4

Please sign in to comment.