dom/ipc/PWindowGlobal.ipdl
author Kartikaya Gupta <kgupta@mozilla.com>
Mon, 06 May 2019 22:14:40 +0000
changeset 531641 7748746bf2feda8edd0cabfdaff88b7faf059ad5
parent 529313 5a351207ac3efe9a69bc3fe53ba988462b17b8a4
child 537284 30a50a1a8d68a49516ed36325a7882880ac819d5
permissions -rw-r--r--
Bug 1548568 - Cleanup to remove unused guid parameter in callback. r=botond Differential Revision: https://phabricator.services.mozilla.com/D29688

/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
/* vim: set sw=2 ts=8 et tw=80 ft=cpp : */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

include protocol PBrowser;
include protocol PInProcess;
include protocol PBrowserBridge;

include DOMTypes;

using JSWindowActorMessageKind from "mozilla/dom/JSWindowActor.h";

namespace mozilla {
namespace dom {

struct JSWindowActorMessageMeta {
  nsString actorName;
  nsString messageName;
  uint64_t queryId;
  JSWindowActorMessageKind kind;
};

/**
 * A PWindowGlobal actor has a lifetime matching that of a single Window Global,
 * specifically a |nsGlobalWindowInner|. These actors will form a parent/child
 * link either between the chrome/content process, or will be in-process, for
 * documents which are loaded in the chrome process.
 */
async protocol PWindowGlobal
{
  manager PBrowser or PInProcess;

child:
  async __delete__();

  async ChangeFrameRemoteness(BrowsingContext aFrameContext,
                              nsString aRemoteType,
                              uint64_t aSwitchId)
      returns (nsresult rv, nullable PBrowserBridge bridge);

both:
  async RawMessage(JSWindowActorMessageMeta aMetadata, ClonedMessageData aData);

parent:
  /// Update the URI of the document in this WindowGlobal.
  async UpdateDocumentURI(nsIURI aUri);

  /// Notify the parent that this PWindowGlobal is now the current global.
  async BecomeCurrentWindowGlobal();

  /// Notify the parent that this PWindowGlobal has embedded the given
  /// BrowsingContext.
  async DidEmbedBrowsingContext(BrowsingContext aContext);

  async Destroy();
};

} // namespace dom
} // namespace mozilla