dom/messagechannel/PMessagePort.ipdl
author Nicholas Nethercote <nnethercote@mozilla.com>
Thu, 01 Sep 2016 15:01:16 +1000
changeset 312356 93657f8dedaafa384bcd49c71b52e195ec968de8
parent 310603 8c07eaec94c47f0a29d4faa99821caf02eb4becd
child 323466 1eb14c93e19767628f50051ade4362941f8c85d8
permissions -rw-r--r--
Bug 1299727 - Rename NS_WARN_IF_FALSE as NS_WARNING_ASSERTION. r=erahm. The new name makes the sense of the condition much clearer. E.g. compare: NS_WARN_IF_FALSE(!rv.Failed()); with: NS_WARNING_ASSERTION(!rv.Failed()); The new name also makes it clearer that it only has effect in debug builds, because that's standard for assertions.

/* 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 PBackground;
include protocol PBlob;

include DOMTypes;

using struct mozilla::SerializedStructuredCloneBuffer
  from "ipc/IPCMessageUtils.h";

namespace mozilla {
namespace dom {


struct MessagePortMessage
{
  SerializedStructuredCloneBuffer data;
  PBlob[] blobs;
  MessagePortIdentifier[] transferredPorts;
};

// This protocol is used for the MessageChannel/MessagePort API
protocol PMessagePort
{
  manager PBackground;

  /* Many of these methods are used just for the shutdown sequence. The
     correct sequence for the child actor is:
     1. SendStopSendingData();
     2. RecvStopSendingDataConfirmed();
     3. SendClose();
     4. Recv__delete__(); */

  /* When the port is transferred the sequence is:
     1. SendStopSendingData();
     2. RecvStopSendingDataConfirmed();
     3. SendDisentangle();
     4. Recv__delete__(); */

parent:
  async PostMessages(MessagePortMessage[] messages);
  async Disentangle(MessagePortMessage[] messages);
  async StopSendingData();
  async Close();

child:
  async Entangled(MessagePortMessage[] messages);
  async ReceiveData(MessagePortMessage[] messages);
  async StopSendingDataConfirmed();

  async __delete__();
};

} // namespace dom
} // namespace mozilla