Mercurial > hg > orthanc
changeset 6402:b86411c11092 queues-timeout
reviewing documentation
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 12 Nov 2025 19:30:44 +0100 |
| parents | 6766053ee920 |
| children | 36aff9f84264 |
| files | OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h OrthancServer/Plugins/Include/orthanc/OrthancPluginCodeModel.json |
| diffstat | 2 files changed, 20 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h Wed Nov 12 19:13:15 2025 +0100 +++ b/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h Wed Nov 12 19:30:44 2025 +0100 @@ -10414,9 +10414,10 @@ * @param queueId A unique identifier identifying both the plugin and the queue. * @param origin The position from where the value is dequeued (back for LIFO, front for FIFO). * @return 0 if success, other value if error. - * @deprecated This function should not be used anymore because two consumers may consume the same - * value. Use OrthancPluginReserveQueueValue and OrthancPluginAcknowledgeQueueValue instead. - **/ + * @deprecated This function should not be used anymore because there is a risk of loosing + * a value if the consumer plugin crashes before it has processed the value. Use + * OrthancPluginReserveQueueValue() and OrthancPluginAcknowledgeQueueValue() if possible. + **/ ORTHANC_PLUGIN_SINCE_SDK("1.12.8") ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDequeueValue( OrthancPluginContext* context, @@ -10442,7 +10443,7 @@ } _OrthancPluginGetQueueSize; /** - * @brief Get the number of elements in a queue. + * @brief Get the number of elements that are currently stored in a queue. * * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). * @param queueId A unique identifier identifying both the plugin and the queue. @@ -10721,11 +10722,11 @@ } _OrthancPluginReserveQueueValue; /** - * @brief Reserve a value from a queue which means the message is not - * available for other consumers. + * @brief Reserve a value from a queue, which means that the message is not + * available to other consumers. * The value is either: - * - removed from the queue when one calls OrthancPluginAcknowledgeQueueValue - * - or made available again for consumers after the releaseTimeout has expired + * - removed from the queue when one calls OrthancPluginAcknowledgeQueueValue() + * - or made available again for consumers after the releaseTimeout has expired. * * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). * @param found Pointer to a Boolean that is set to "true" iff. a value has been dequeued. @@ -10733,10 +10734,11 @@ * It must be freed with OrthancPluginFreeMemoryBuffer(). * @param queueId A unique identifier identifying both the plugin and the queue. * @param origin The position from where the value is dequeued (back for LIFO, front for FIFO). - * @param releaseTimeout Timeout in seconds. If the value is not acknowledge within this - * timeout, the value is automatically released and made available for further - * calls to OrthancPluginDequeueValue or OrthancPluginReserveQueueValue - * @param valueId An opaque id to use in OrthancPluginAcknowledgeQueueValue + * @param releaseTimeout Timeout in seconds. If the value is not acknowledged before this delay expires, + * the value is automatically released and made available for further calls to + * OrthancPluginDequeueValue() or OrthancPluginReserveQueueValue() + * @param valueId An opaque identifier for this value, to be subsequently provided to + * OrthancPluginAcknowledgeQueueValue(). * @return 0 if success, other value if error. **/ ORTHANC_PLUGIN_SINCE_SDK("1.12.10") @@ -10767,11 +10769,12 @@ } _OrthancPluginAcknowledgeQueueValue; /** - * @brief Acknowledge that a queue value has been consumed and definitely removes it from the queue. + * @brief Acknowledge that a queue value has been properly consumed by the plugin + * and can be definitely removed from the queue. * * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). * @param queueId A unique identifier identifying both the plugin and the queue. - * @param valueId An opaque id obtained from OrthancPluginReserveQueueValue + * @param valueId The opaque identifier for the value obtained from OrthancPluginReserveQueueValue(). * @return 0 if success, other value if error. **/ ORTHANC_PLUGIN_SINCE_SDK("1.12.10") @@ -10785,7 +10788,7 @@ params.valueId = valueId; return context->InvokeService(context, _OrthancPluginService_AcknowledgeQueueValue, ¶ms); - } + } #ifdef __cplusplus }
--- a/OrthancServer/Plugins/Include/orthanc/OrthancPluginCodeModel.json Wed Nov 12 19:13:15 2025 +0100 +++ b/OrthancServer/Plugins/Include/orthanc/OrthancPluginCodeModel.json Wed Nov 12 19:30:44 2025 +0100 @@ -5504,11 +5504,11 @@ "documentation": { "args": { "queueId": "A unique identifier identifying both the plugin and the queue.", - "valueId": "An opaque id obtained from OrthancPluginReserveQueueValue" + "valueId": "The opaque identifier for the value obtained from OrthancPluginReserveQueueValue()." }, "description": [], "return": "0 if success, other value if error.", - "summary": "Acknowledge that a queue value has been consumed and definitely removes it from the queue." + "summary": "Acknowledge that a queue value has been properly consumed by the plugin and can be definitely removed from the queue." }, "return_sdk_enumeration": "OrthancPluginErrorCode", "return_sdk_type": "enumeration",
