0

Add some more documentation from a recent ppapi discussion.

BUG=none
TEST=trybots

Review URL: http://codereview.chromium.org/6656016

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@77668 0039d316-1c4b-4281-b951-d872f2087c98
This commit is contained in:
nfullagar@google.com
2011-03-10 19:12:10 +00:00
parent 613af4d3f8
commit cb66596fd7
2 changed files with 12 additions and 4 deletions

@ -32,10 +32,14 @@ typedef void (*PP_CompletionCallback_Func)(void* user_data, int32_t result);
/**
* Any method that takes a PP_CompletionCallback has the option of completing
* asynchronously if the operation would block. Such a method should return
* PP_Error_WouldBlock to indicate when the method will complete
* asynchronously. If the completion callback is NULL, then the operation will
* block if necessary to complete its work. PP_BlockUntilComplete() provides a
* convenient way to specify blocking behavior.
* PP_ERROR_WOULDBLOCK to indicate that the method will complete
* asynchronously. In this case it will signal completion by invoking the
* supplied completion callback, which will always be invoked from the main
* PPAPI thread of execution. If the method returns any other value,
* including PP_OK, the completion callback will not be invoked. If the
* completion callback is NULL, then the method will block if necessary to
* complete its work. PP_BlockUntilComplete() provides a convenient way to
* specify blocking behavior.
*
* The result parameter passes an int32_t that if negative indicates an error
* code. Otherwise the result value indicates success. If it is a positive

@ -103,6 +103,10 @@ struct PPB_Core {
* callback. Many applications won't need this, but it allows a plugin to
* emulate calls of some callbacks which do use this value.
*
* NOTE: CallOnMainThread, even when used from the main thread with a delay
* of 0 milliseconds, will never directly invoke the callback. Even in this
* case, the callback will be scheduled asynchronously.
*
* NOTE: If the browser is shutting down or if the plugin has no instances,
* then the callback function may not be called.
*