dom/plugins/PPluginBackgroundDestroyer.ipdl

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: sw=4 ts=8 et :
   3  */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at:
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is Mozilla Code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  *   The Mozilla Foundation
  21  * Portions created by the Initial Developer are Copyright (C) 2010
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Chris Jones <jones.chris.g@gmail.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 include protocol PPluginInstance;
  42
  43 namespace mozilla {
  44 namespace plugins {
  45
  46 /**
  47  * This protocol exists to allow us to correctly destroy background
  48  * surfaces.  The browser owns the surfaces, but shares a "reference"
  49  * with the plugin.  The browser needs to notify the plugin when the
  50  * background is going to be destroyed, but it can't rely on the
  51  * plugin to destroy it because the plugin may crash at any time.  So
  52  * the plugin instance relinquishes destruction of the its old
  53  * background to actors of this protocol, which can deal with crashy
  54  * corner cases more easily than the instance.
  55  */
  56 protocol PPluginBackgroundDestroyer {
  57     manager PPluginInstance;
  58
  59     // The ctor message for this protocol serves double-duty as
  60     // notification that that the background is stale.
  61
  62 parent:
  63     __delete__();
  64
  65 state DESTROYING:
  66     recv __delete__;
  67 };
  68
  69 }  // namespace plugins
  70 }  // namespace mozilla