summaryrefslogtreecommitdiffstats
path: root/doc/opal-api/opal-check-async-completion-86.rst
blob: 9c1505f5acbed933a020ddd227f82be0eee63068 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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.
OpenPOWER on IntegriCloud