src/core/model/system-thread.h
changeset 7169 358f71a624d8
parent 6821 203367ae7433
child 7386 2310ed220a61
equal deleted inserted replaced
7168:7c724be8f9a6 7169:358f71a624d8
   152    * @brief Indicates to a thread doing cooperative multithreading that
   152    * @brief Indicates to a thread doing cooperative multithreading that
   153    * its managing thread wants it to exit.
   153    * its managing thread wants it to exit.
   154    *
   154    *
   155    * It is often the case that we want a thread to be off doing work until such
   155    * It is often the case that we want a thread to be off doing work until such
   156    * time as its job is done.  We then want the thread to exit itself.  This
   156    * time as its job is done.  We then want the thread to exit itself.  This
   157    * method allows a thread to query whether or not it should be running.  
   157    * method allows a thread to query whether or not it should be running.
   158    * Typically, the worker thread is running in a forever-loop, and will need to
   158    * Typically, the worker thread is running in a forever-loop, and will need to
   159    * "break" out of that loop to exit -- thus the name.
   159    * "break" out of that loop to exit -- thus the name.
   160    *
   160    *
   161    * @see Shutdown
   161    * @see Shutdown
   162    * @returns true if thread is expected to exit (break out of the forever-loop)
   162    * @returns true if thread is expected to exit (break out of the forever-loop)