2009-09-09 06:31:35 +00:00
|
|
|
/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
|
2009-09-09 14:04:09 +00:00
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2009-06-30 18:51:05 +00:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is Mozilla Plugin App.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
2009-09-09 06:31:35 +00:00
|
|
|
* Benjamin Smedberg <benjamin@smedbergs.us>
|
2009-06-30 18:51:05 +00:00
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2009
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
2009-09-09 14:04:09 +00:00
|
|
|
#ifndef mozilla_plugins_BrowserStreamChild_h
|
|
|
|
#define mozilla_plugins_BrowserStreamChild_h 1
|
2009-06-30 18:51:05 +00:00
|
|
|
|
2009-09-09 22:59:06 +00:00
|
|
|
#include "mozilla/plugins/PBrowserStreamChild.h"
|
2009-09-21 14:51:35 +00:00
|
|
|
#include "mozilla/plugins/AStream.h"
|
2009-06-30 18:51:05 +00:00
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace plugins {
|
|
|
|
|
2009-09-09 06:31:35 +00:00
|
|
|
class PluginInstanceChild;
|
2010-03-06 21:03:05 +00:00
|
|
|
class StreamNotifyChild;
|
2009-09-09 06:31:35 +00:00
|
|
|
|
2009-09-21 14:51:35 +00:00
|
|
|
class BrowserStreamChild : public PBrowserStreamChild, public AStream
|
2009-06-30 18:51:05 +00:00
|
|
|
{
|
2009-08-10 23:28:22 +00:00
|
|
|
public:
|
2009-09-09 14:04:09 +00:00
|
|
|
BrowserStreamChild(PluginInstanceChild* instance,
|
|
|
|
const nsCString& url,
|
|
|
|
const uint32_t& length,
|
|
|
|
const uint32_t& lastmodified,
|
2010-03-06 21:03:05 +00:00
|
|
|
StreamNotifyChild* notifyData,
|
2009-09-09 14:04:09 +00:00
|
|
|
const nsCString& headers,
|
|
|
|
const nsCString& mimeType,
|
|
|
|
const bool& seekable,
|
|
|
|
NPError* rv,
|
|
|
|
uint16_t* stype);
|
2010-03-06 21:03:05 +00:00
|
|
|
virtual ~BrowserStreamChild();
|
2009-09-09 06:31:35 +00:00
|
|
|
|
2009-09-21 14:51:35 +00:00
|
|
|
NS_OVERRIDE virtual bool IsBrowserStream() { return true; }
|
|
|
|
|
2010-01-12 23:06:18 +00:00
|
|
|
NPError StreamConstructed(
|
|
|
|
const nsCString& mimeType,
|
|
|
|
const bool& seekable,
|
|
|
|
uint16_t* stype);
|
|
|
|
|
2010-02-23 21:45:00 +00:00
|
|
|
virtual bool RecvWrite(const int32_t& offset,
|
|
|
|
const Buffer& data,
|
|
|
|
const uint32_t& newsize);
|
2009-09-17 23:09:20 +00:00
|
|
|
virtual bool AnswerNPP_StreamAsFile(const nsCString& fname);
|
2010-02-23 21:45:00 +00:00
|
|
|
virtual bool RecvNPP_DestroyStream(const NPReason& reason);
|
|
|
|
virtual bool Recv__delete__();
|
2009-09-09 06:31:35 +00:00
|
|
|
|
2009-09-15 19:48:18 +00:00
|
|
|
void EnsureCorrectInstance(PluginInstanceChild* i)
|
|
|
|
{
|
|
|
|
if (i != mInstance)
|
|
|
|
NS_RUNTIMEABORT("Incorrect stream instance");
|
|
|
|
}
|
2009-09-22 21:06:00 +00:00
|
|
|
void EnsureCorrectStream(NPStream* s)
|
|
|
|
{
|
|
|
|
if (s != &mStream)
|
|
|
|
NS_RUNTIMEABORT("Incorrect stream data");
|
|
|
|
}
|
2009-09-15 19:48:18 +00:00
|
|
|
|
2009-09-22 21:06:00 +00:00
|
|
|
NPError NPN_RequestRead(NPByteRange* aRangeList);
|
2010-03-06 21:02:31 +00:00
|
|
|
void NPN_DestroyStream(NPReason reason);
|
2009-09-21 14:51:35 +00:00
|
|
|
|
2010-03-06 21:03:05 +00:00
|
|
|
void NotifyPending() {
|
|
|
|
NS_ASSERTION(!mNotifyPending, "Pending twice?");
|
|
|
|
mNotifyPending = true;
|
|
|
|
EnsureDeliveryPending();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* During instance destruction, artificially cancel all outstanding streams.
|
|
|
|
*
|
|
|
|
* @return false if we are already in the DELETING state.
|
|
|
|
*/
|
|
|
|
bool InstanceDying() {
|
|
|
|
if (DELETING == mState)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
mInstanceDying = true;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void FinishDelivery() {
|
|
|
|
NS_ASSERTION(mInstanceDying, "Should only be called after InstanceDying");
|
|
|
|
NS_ASSERTION(DELETING != mState, "InstanceDying didn't work?");
|
2010-03-11 19:15:48 +00:00
|
|
|
mStreamStatus = NPRES_USER_BREAK;
|
2010-03-06 21:03:05 +00:00
|
|
|
Deliver();
|
|
|
|
NS_ASSERTION(!mStreamNotify, "Didn't deliver NPN_URLNotify?");
|
|
|
|
}
|
|
|
|
|
2009-09-09 06:31:35 +00:00
|
|
|
private:
|
2010-03-06 21:03:05 +00:00
|
|
|
friend class StreamNotifyChild;
|
2010-03-06 21:02:31 +00:00
|
|
|
using PBrowserStreamChild::SendNPN_DestroyStream;
|
|
|
|
|
2010-02-23 21:45:00 +00:00
|
|
|
/**
|
2010-03-06 21:03:05 +00:00
|
|
|
* Post an event to ensure delivery of pending data/destroy/urlnotify events
|
|
|
|
* outside of the current RPC stack.
|
|
|
|
*/
|
|
|
|
void EnsureDeliveryPending();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deliver data, destruction, notify scheduling
|
2010-02-23 21:45:00 +00:00
|
|
|
* or cancelling the suspended timer as needed.
|
|
|
|
*/
|
2010-03-06 21:03:05 +00:00
|
|
|
void Deliver();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deliver one chunk of pending data.
|
|
|
|
* @return true if the plugin indicated a pause was necessary
|
|
|
|
*/
|
|
|
|
bool DeliverPendingData();
|
|
|
|
|
2010-02-23 21:45:00 +00:00
|
|
|
void SetSuspendedTimer();
|
|
|
|
void ClearSuspendedTimer();
|
|
|
|
|
2009-09-09 06:31:35 +00:00
|
|
|
PluginInstanceChild* mInstance;
|
|
|
|
NPStream mStream;
|
2010-03-06 21:03:05 +00:00
|
|
|
|
|
|
|
static const NPReason kStreamOpen = -1;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The plugin's notion of whether a stream has been "closed" (no more
|
|
|
|
* data delivery) differs from the plugin host due to asynchronous delivery
|
|
|
|
* of data and NPN_DestroyStream. While the plugin-visible stream is open,
|
|
|
|
* mStreamStatus should be kStreamOpen (-1). mStreamStatus will be a
|
|
|
|
* failure code if either the parent or child indicates stream failure.
|
|
|
|
*/
|
|
|
|
NPReason mStreamStatus;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delivery of NPP_DestroyStream and NPP_URLNotify must be postponed until
|
|
|
|
* all data has been delivered.
|
|
|
|
*/
|
|
|
|
enum {
|
|
|
|
NOT_DESTROYED, // NPP_DestroyStream not yet received
|
|
|
|
DESTROY_PENDING, // NPP_DestroyStream received, not yet delivered
|
|
|
|
DESTROYED // NPP_DestroyStream delivered, NPP_URLNotify may still be pending
|
|
|
|
} mDestroyPending;
|
|
|
|
bool mNotifyPending;
|
|
|
|
|
|
|
|
// When NPP_Destroy is called for our instance (manager), this flag is set
|
|
|
|
// cancels the stream and avoids sending StreamDestroyed.
|
|
|
|
bool mInstanceDying;
|
|
|
|
|
2010-02-23 21:45:00 +00:00
|
|
|
enum {
|
|
|
|
CONSTRUCTING,
|
|
|
|
ALIVE,
|
|
|
|
DYING,
|
|
|
|
DELETING
|
|
|
|
} mState;
|
2009-09-09 06:31:35 +00:00
|
|
|
nsCString mURL;
|
|
|
|
nsCString mHeaders;
|
2010-03-06 21:03:05 +00:00
|
|
|
StreamNotifyChild* mStreamNotify;
|
2010-03-06 21:02:31 +00:00
|
|
|
|
2010-02-23 21:45:00 +00:00
|
|
|
struct PendingData
|
|
|
|
{
|
|
|
|
int32_t offset;
|
|
|
|
Buffer data;
|
|
|
|
int32_t curpos;
|
|
|
|
};
|
|
|
|
nsTArray<PendingData> mPendingData;
|
|
|
|
|
2010-03-06 21:02:31 +00:00
|
|
|
/**
|
|
|
|
* Asynchronous RecvWrite messages are never delivered to the plugin
|
|
|
|
* immediately, because that may be in the midst of an unexpected RPC
|
|
|
|
* stack frame. It instead posts a runnable using this tracker to cancel
|
|
|
|
* in case we are destroyed.
|
|
|
|
*/
|
2010-03-06 21:03:05 +00:00
|
|
|
ScopedRunnableMethodFactory<BrowserStreamChild> mDeliveryTracker;
|
2010-02-23 21:45:00 +00:00
|
|
|
base::RepeatingTimer<BrowserStreamChild> mSuspendedTimer;
|
2009-06-30 18:51:05 +00:00
|
|
|
};
|
|
|
|
|
2009-09-09 06:31:35 +00:00
|
|
|
} // namespace plugins
|
|
|
|
} // namespace mozilla
|
2009-06-30 18:51:05 +00:00
|
|
|
|
2009-09-09 14:04:09 +00:00
|
|
|
#endif /* mozilla_plugins_BrowserStreamChild_h */
|