ppapi/c/private/ppb_proxy_private.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef PPAPI_C_PRIVATE_PROXY_PRIVATE_H_
   6 #define PPAPI_C_PRIVATE_PROXY_PRIVATE_H_
   7
   8 #include "ppapi/c/pp_bool.h"
   9 #include "ppapi/c/pp_instance.h"
  10 #include "ppapi/c/pp_module.h"
  11 #include "ppapi/c/pp_resource.h"
  12
  13 #define PPB_PROXY_PRIVATE_INTERFACE "PPB_Proxy_Private;6"
  14
  15 // Exposes functions needed by the out-of-process proxy to call into the
  16 // renderer PPAPI implementation.
  17 struct PPB_Proxy_Private {
  18   // Called when the given plugin process has crashed.
  19   void (*PluginCrashed)(PP_Module module);
  20
  21   // Returns the instance for the given resource, or 0 on failure.
  22   PP_Instance (*GetInstanceForResource)(PP_Resource resource);
  23
  24   // Sets a callback that will be used to make sure that PP_Instance IDs
  25   // are unique in the plugin.
  26   //
  27   // Since the plugin may be shared between several browser processes, we need
  28   // to do extra work to make sure that an instance ID is globally unqiue. The
  29   // given function will be called and will return true if the given
  30   // PP_Instance is OK to use in the plugin. It will then be marked as "in use"
  31   // On failure (returns false), the host implementation will generate a new
  32   // instance ID and try again.
  33   void (*SetReserveInstanceIDCallback)(
  34       PP_Module module,
  35       PP_Bool (*is_seen)(PP_Module, PP_Instance));
  36
  37   // Allows adding additional refcounts to the PluginModule that owns the
  38   // proxy dispatcher (and all interface proxies). For every AddRef call
  39   // there must be a corresponding release call.
  40   void (*AddRefModule)(PP_Module module);
  41   void (*ReleaseModule)(PP_Module module);
  42
  43   // Allows asserts to be written for some bad conditions while cleaning up.
  44   PP_Bool (*IsInModuleDestructor)(PP_Module module);
  45 };
  46
  47 #endif  // PPAPI_C_PRIVATE_PROXY_PRIVATE_H_