Updated 'create_thread' function comments.

[nit.git] / lib / pnacl.nit

diff --git a/lib/pnacl.nit b/lib/pnacl.nit
index fde40f3..42a6b8c 100644 (file)
--- a/lib/pnacl.nit
+++ b/lib/pnacl.nit
@@ -725,7 +725,21 @@ class PnaclApp
 end
 
 redef interface Object
-       # Calls 'pthread_exit on current thread
+       # Creates a new thread for Nit.
+       #
+       # This function launches the Nit main on a new thread.
+       # Its purpose is to allow Nit to be still operational after an exit when needed,
+       # because reloading the page may not be an option.
+       #
+       # Should only be used within the 'exit' before stopping the current thread
+       # when the Nit execution causes a crash.
+       #
+       # REQUIRE: g_nit_thread and WrapperNitMain are set.
+       fun create_thread `{
+               pthread_create(&g_nit_thread, NULL, &WrapperNitMain, NULL);
+       `}
+
+       # Calls 'pthread_exit on current thread.
         fun exit_thread(exit_value: Int) `{
                pthread_exit((void*) exit_value);
        `}