add process-kill to the list

[simgrid.git] / examples / msg / process-kill / process-kill.c

diff --git a/examples/msg/process-kill/process-kill.c b/examples/msg/process-kill/process-kill.c
index d33e372..ed6c622 100644 (file)
--- a/examples/msg/process-kill/process-kill.c
+++ b/examples/msg/process-kill/process-kill.c
@@ -6,31 +6,34 @@
 
 #include "simgrid/msg.h"
 
 
 #include "simgrid/msg.h"
 

-XBT_LOG_NEW_DEFAULT_CATEGORY(msg_test, "Messages specific for this msg example");
+XBT_LOG_NEW_DEFAULT_CATEGORY(msg_process_kill, "Messages specific for this msg example");
+/** @addtogroup MSG_examples
+ *
+ *  - <b>Process Killing: process-kill/process-kill.c</b>. Processes can also be killed by another if needed thanks to
+ *    the @ref MSG_process_kill function.
+ */

 
 static int victim(int argc, char *argv[])
 {
   XBT_INFO("Hello!");
   XBT_INFO("Suspending myself");
 
 static int victim(int argc, char *argv[])
 {
   XBT_INFO("Hello!");
   XBT_INFO("Suspending myself");

-  MSG_process_suspend(MSG_process_self());
-  XBT_INFO("OK, OK. Let's work");
+  MSG_process_suspend(MSG_process_self()); /** - First suspend itself */
+  XBT_INFO("OK, OK. Let's work");          /** - Then is resumed and start to execute a task */

   MSG_task_execute(MSG_task_create("work", 1e9, 0, NULL));
   MSG_task_execute(MSG_task_create("work", 1e9, 0, NULL));

-  XBT_INFO("Bye!");
+  XBT_INFO("Bye!");  /** - But will never reach the end of it */

   return 0;
 }
 
 static int killer(int argc, char *argv[])
 {
   return 0;
 }
 
 static int killer(int argc, char *argv[])
 {

-  msg_process_t poor_victim = NULL;
-
-  XBT_INFO("Hello!");
-  poor_victim = MSG_process_create("victim", victim, NULL, MSG_host_by_name("Fafard"));
+  XBT_INFO("Hello!");         /** - First start a @ref victim process */
+  msg_process_t poor_victim = MSG_process_create("victim", victim, NULL, MSG_host_by_name("Fafard"));

   MSG_process_sleep(10.0);
 
   MSG_process_sleep(10.0);
 

-  XBT_INFO("Resume process");
+  XBT_INFO("Resume process"); /** - Resume it from its suspended state */

   MSG_process_resume(poor_victim);
 
   MSG_process_resume(poor_victim);
 

-  XBT_INFO("Kill process");
+  XBT_INFO("Kill process");   /** - and then kill it */

   MSG_process_kill(poor_victim);
 
   XBT_INFO("OK, goodbye now.");
   MSG_process_kill(poor_victim);
 
   XBT_INFO("OK, goodbye now.");


@@ -44,15 +47,14 @@ int main(int argc, char *argv[])
   MSG_init(&argc, argv);
   xbt_assert(argc == 2, "Usage: %s platform_file\n\tExample: %s msg_platform.xml\n", argv[0], argv[0]);
 
   MSG_init(&argc, argv);
   xbt_assert(argc == 2, "Usage: %s platform_file\n\tExample: %s msg_platform.xml\n", argv[0], argv[0]);
 

-  MSG_create_environment(argv[1]);
-
+  MSG_create_environment(argv[1]);   /** - Load the platform description */
+  /** - Create and deploy @ref killer process */

   MSG_function_register("killer", killer);
   MSG_function_register("victim", victim);
   MSG_process_create("killer", killer, NULL, MSG_host_by_name("Tremblay"));
 
   MSG_function_register("killer", killer);
   MSG_function_register("victim", victim);
   MSG_process_create("killer", killer, NULL, MSG_host_by_name("Tremblay"));
 

-  res = MSG_main();
+  res = MSG_main();                 /** - Run the simulation */

 
   XBT_INFO("Simulation time %g", MSG_get_clock());
 
   XBT_INFO("Simulation time %g", MSG_get_clock());

-

   return res != MSG_OK;
 }
   return res != MSG_OK;
 }