diff options
Diffstat (limited to 'doc/opal-api/opal-check-async-completion-86.rst')
-rw-r--r-- | doc/opal-api/opal-check-async-completion-86.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/opal-api/opal-check-async-completion-86.rst b/doc/opal-api/opal-check-async-completion-86.rst new file mode 100644 index 00000000..9c1505f5 --- /dev/null +++ b/doc/opal-api/opal-check-async-completion-86.rst @@ -0,0 +1,30 @@ +OPAL_CHECK_ASYNC_COMPLETION +=========================== + +OPAL_CHECK_ASYNC_COMPLETION checks if an async OPAL pending message was completed. (see :ref:`opal-messages`). + +.. code-block:: c + + int64_t opal_check_completion(uint64_t *buffer, uint64_t size, uint64_t token); + +Parameters: + +buffer + buffer to copy message into +size + sizeof buffer to copy message into +token + async message token + + +Return values +------------- + +OPAL_PARAMETER + buffer parameter is an invalid pointer (NULL or > top of RAM). + +OPAL_SUCCESS + message successfully copied to buffer. + +OPAL_BUSY + message is still pending and should be re-checked later. |