changeset 2819:1b6497e412e4

doc
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 13 Sep 2018 09:03:39 +0200
parents a47938d99dfa
children 3e048b243d20
files Plugins/Include/orthanc/OrthancCPlugin.h
diffstat 1 files changed, 10 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/Plugins/Include/orthanc/OrthancCPlugin.h	Wed Sep 12 17:52:28 2018 +0200
+++ b/Plugins/Include/orthanc/OrthancCPlugin.h	Thu Sep 13 09:03:39 2018 +0200
@@ -1353,11 +1353,6 @@
    * this method, as long as it returns
    * OrthancPluginJobStepStatus_Continue.
    *
-   * Orthanc starts one dedicated thread per custom job that is
-   * running. It is guaranteed that this method will only be called
-   * from this dedicated thread: As a consequence, it is *not*
-   * mandatory to protect this method by mutexes.
-   *
    * @param job The job of interest.
    * @return The status of execution.
    * @ingroup Toolbox
@@ -6201,6 +6196,16 @@
    *
    * This function creates a custom job to be run by the jobs engine
    * of Orthanc.
+   * 
+   * Orthanc starts one dedicated thread per custom job that is
+   * running. It is guaranteed that all the callbacks will only be
+   * called from this single dedicated thread, in mutual exclusion: As
+   * a consequence, it is *not* mandatory to protect the various
+   * callbacks by mutexes.
+   * 
+   * The custom job can nonetheless launch its own processing threads
+   * on the first call to the "step()" callback, and stop them once
+   * the "stop()" callback is called.
    *
    * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
    * @param job The job to be executed.