Pepper_56_C_interfaces
Pepper_56_C_interfaces
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Public Attributes | List of all members
PPB_Flash_MessageLoop_0_1 Struct Reference
Interfaces

#include <ppb_flash_message_loop.h>

Public Attributes

PP_Resource(* Create )(PP_Instance instance)
 
PP_Bool(* IsFlashMessageLoop )(PP_Resource resource)
 
int32_t(* Run )(PP_Resource flash_message_loop)
 
void(* Quit )(PP_Resource flash_message_loop)
 

Detailed Description

The PPB_Flash_MessageLoop interface supports Pepper Flash to run nested message loops.

Member Data Documentation

PP_Resource(* PPB_Flash_MessageLoop_0_1::Create)(PP_Instance instance)

Allocates a Flash message loop resource.

Parameters
[in]instanceA PP_Instance identifying one instance of a module.
Returns
A PP_Resource that can be used to run a nested message loop if successful; 0 if failed.
PP_Bool(* PPB_Flash_MessageLoop_0_1::IsFlashMessageLoop)(PP_Resource resource)

Determines if a given resource is a Flash message loop.

Parameters
[in]resourceA PP_Resource corresponding to a generic resource.
Returns
A PP_Bool that is PP_TRUE if the given resource is a Flash message loop, otherwise PP_FALSE.
void(* PPB_Flash_MessageLoop_0_1::Quit)(PP_Resource flash_message_loop)

Signals to quit the outermost nested message loop. Use this to exit and return back to the caller after you call Run().

If Quit() is not called to balance the call to Run(), the outermost nested message loop will be quitted implicitly when the resource is destroyed.

Parameters
[in]flash_message_loopThe Flash message loop.
int32_t(* PPB_Flash_MessageLoop_0_1::Run)(PP_Resource flash_message_loop)

Runs a nested message loop. The plugin will be reentered from this call. This function is used in places where Flash would normally enter a nested message loop (e.g., when displaying context menus), but Pepper provides only an asynchronous call. After performing that asynchronous call, call Run(). In the callback, call Quit().

For a given message loop resource, only the first call to Run() will start a nested message loop. The subsequent calls will return PP_ERROR_FAILED immediately.

Parameters
[in]flash_message_loopThe Flash message loop.
Returns
PP_ERROR_ABORTED if the message loop quits because the resource is destroyed; PP_OK if the message loop quits because of other reasons (e.g., Quit() is called); PP_ERROR_FAILED if this is not the first call to Run().
The documentation for this struct was generated from the following file: