summaryrefslogtreecommitdiffstats
path: root/dom/plugins/ipc/PBrowserStream.ipdl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/plugins/ipc/PBrowserStream.ipdl')
-rw-r--r--dom/plugins/ipc/PBrowserStream.ipdl69
1 files changed, 69 insertions, 0 deletions
diff --git a/dom/plugins/ipc/PBrowserStream.ipdl b/dom/plugins/ipc/PBrowserStream.ipdl
new file mode 100644
index 000000000..dbd238750
--- /dev/null
+++ b/dom/plugins/ipc/PBrowserStream.ipdl
@@ -0,0 +1,69 @@
+/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
+/* 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 PPluginInstance;
+
+
+using mozilla::plugins::Buffer from "mozilla/plugins/PluginMessageUtils.h";
+using mozilla::plugins::IPCByteRanges from "mozilla/plugins/PluginMessageUtils.h";
+
+using NPError from "npapi.h";
+using NPReason from "npapi.h";
+
+namespace mozilla {
+namespace plugins {
+
+/**
+ * NPBrowserStream represents a NPStream sent from the browser to the plugin.
+ */
+
+intr protocol PBrowserStream
+{
+ manager PPluginInstance;
+
+child:
+ async Write(int32_t offset, uint32_t newlength,
+ Buffer data);
+ async NPP_StreamAsFile(nsCString fname);
+
+ /**
+ * NPP_DestroyStream may race with other messages: the child acknowledges
+ * the message with StreamDestroyed before this actor is deleted.
+ */
+ async NPP_DestroyStream(NPReason reason);
+ async __delete__();
+
+parent:
+ async AsyncNPP_NewStreamResult(NPError rv, uint16_t stype);
+ intr NPN_RequestRead(IPCByteRanges ranges)
+ returns (NPError result);
+ async NPN_DestroyStream(NPReason reason);
+ async StreamDestroyed();
+
+/*
+ TODO: turn on state machine.
+
+ // need configurable start state: if the constructor
+ // returns an error in result, start state should
+ // be DELETING.
+start state ALIVE:
+ send Write goto ALIVE;
+ call NPP_StreamAsFile goto ALIVE;
+ send NPP_DestroyStream goto ALIVE;
+ answer NPN_RequestRead goto ALIVE;
+ recv NPN_DestroyStream goto DYING;
+
+state DYING:
+ answer NPN_RequestRead goto DYING;
+ recv NPN_DestroyStream goto DYING;
+ recv StreamDestroyed goto DELETING;
+
+state DELETING:
+ send __delete__;
+*/
+};
+
+} // namespace plugins
+} // namespace mozilla