gecko-dev/dom/plugins/ipc/PBrowserStream.ipdl
2012-05-21 12:12:37 +01:00

70 lines
1.7 KiB
Plaintext

/* -*- 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;
include "mozilla/plugins/PluginMessageUtils.h";
using mozilla::plugins::Buffer;
using mozilla::plugins::IPCByteRanges;
using NPError;
using NPReason;
namespace mozilla {
namespace plugins {
/**
* NPBrowserStream represents a NPStream sent from the browser to the plugin.
*/
rpc protocol PBrowserStream
{
manager PPluginInstance;
child:
async Write(int32_t offset, Buffer data,
uint32_t newlength);
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:
rpc 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