mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-09-10 11:54:40 +00:00
193 lines
5.6 KiB
C
193 lines
5.6 KiB
C
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
||
|
/* 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/. */
|
||
|
|
||
|
#ifndef mozilla_dom_MessagePort_h
|
||
|
#define mozilla_dom_MessagePort_h
|
||
|
|
||
|
#include "mozilla/Attributes.h"
|
||
|
#include "mozilla/DOMEventTargetHelper.h"
|
||
|
#include "nsIIPCBackgroundChildCreateCallback.h"
|
||
|
#include "nsTArray.h"
|
||
|
|
||
|
#ifdef XP_WIN
|
||
|
#undef PostMessage
|
||
|
#endif
|
||
|
|
||
|
class nsPIDOMWindow;
|
||
|
|
||
|
namespace mozilla {
|
||
|
namespace dom {
|
||
|
|
||
|
class DispatchEventRunnable;
|
||
|
class MessagePortChild;
|
||
|
class MessagePortIdentifier;
|
||
|
class MessagePortMessage;
|
||
|
class PostMessageRunnable;
|
||
|
class SharedMessagePortMessage;
|
||
|
|
||
|
namespace workers {
|
||
|
class WorkerFeature;
|
||
|
} // namespace workers
|
||
|
|
||
|
class MessagePort final : public DOMEventTargetHelper
|
||
|
, public nsIIPCBackgroundChildCreateCallback
|
||
|
, public nsIObserver
|
||
|
{
|
||
|
friend class DispatchEventRunnable;
|
||
|
friend class PostMessageRunnable;
|
||
|
|
||
|
public:
|
||
|
NS_DECL_NSIIPCBACKGROUNDCHILDCREATECALLBACK
|
||
|
NS_DECL_NSIOBSERVER
|
||
|
NS_DECL_ISUPPORTS_INHERITED
|
||
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(MessagePort,
|
||
|
DOMEventTargetHelper)
|
||
|
|
||
|
static already_AddRefed<MessagePort>
|
||
|
Create(nsPIDOMWindow* aWindow, const nsID& aUUID,
|
||
|
const nsID& aDestinationUUID, ErrorResult& aRv);
|
||
|
|
||
|
static already_AddRefed<MessagePort>
|
||
|
Create(nsPIDOMWindow* aWindow, const MessagePortIdentifier& aIdentifier,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
// For IPC.
|
||
|
static void
|
||
|
ForceClose(const MessagePortIdentifier& aIdentifier);
|
||
|
|
||
|
virtual JSObject*
|
||
|
WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
|
||
|
|
||
|
void
|
||
|
PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
|
||
|
const Optional<Sequence<JS::Value>>& aTransferable,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
void Start();
|
||
|
|
||
|
void Close();
|
||
|
|
||
|
EventHandlerNonNull* GetOnmessage();
|
||
|
|
||
|
void SetOnmessage(EventHandlerNonNull* aCallback);
|
||
|
|
||
|
// Non WebIDL methods
|
||
|
|
||
|
void UnshippedEntangle(MessagePort* aEntangledPort);
|
||
|
|
||
|
void CloneAndDisentangle(MessagePortIdentifier& aIdentifier);
|
||
|
|
||
|
void CloseForced();
|
||
|
|
||
|
// These methods are useful for MessagePortChild
|
||
|
|
||
|
void Entangled(nsTArray<MessagePortMessage>& aMessages);
|
||
|
void MessagesReceived(nsTArray<MessagePortMessage>& aMessages);
|
||
|
void StopSendingDataConfirmed();
|
||
|
void Closed();
|
||
|
|
||
|
private:
|
||
|
explicit MessagePort(nsPIDOMWindow* aWindow);
|
||
|
~MessagePort();
|
||
|
|
||
|
enum State {
|
||
|
// When a port is created by a MessageChannel it is entangled with the
|
||
|
// other. They both run on the same thread, same event loop and the
|
||
|
// messages are added to the queues without using PBackground actors.
|
||
|
// When one of the port is shipped, the state is changed to
|
||
|
// StateEntangling.
|
||
|
eStateUnshippedEntangled,
|
||
|
|
||
|
// If the port is closed or cloned when we are in this state, we go in one
|
||
|
// of the following 2 steps. EntanglingForClose or ForDisentangle.
|
||
|
eStateEntangling,
|
||
|
|
||
|
// We are not fully entangled yet but are already disentangled.
|
||
|
eStateEntanglingForDisentangle,
|
||
|
|
||
|
// We are not fully entangled yet but are already closed.
|
||
|
eStateEntanglingForClose,
|
||
|
|
||
|
// When entangled() is received we send all the messages in the
|
||
|
// mMessagesForTheOtherPort to the actor and we change the state to
|
||
|
// StateEntangled. At this point the port is entangled with the other. We
|
||
|
// send and receive messages.
|
||
|
// If the port queue is not enabled, the received messages are stored in
|
||
|
// the mMessages.
|
||
|
eStateEntangled,
|
||
|
|
||
|
// When the port is cloned or disentangled we want to stop receiving
|
||
|
// messages. We call 'SendStopSendingData' to the actor and we wait for an
|
||
|
// answer. All the messages received between now and the
|
||
|
// 'StopSendingDataComfirmed are queued in the mMessages but not
|
||
|
// dispatched.
|
||
|
eStateDisentangling,
|
||
|
|
||
|
// When 'StopSendingDataConfirmed' is received, we can disentangle the port
|
||
|
// calling SendDisentangle in the actor because we are 100% sure that we
|
||
|
// don't receive any other message, so nothing will be lost.
|
||
|
// Disentangling the port we send all the messages from the mMessages
|
||
|
// though the actor.
|
||
|
eStateDisentangled,
|
||
|
|
||
|
// We are here if Close() has been called. We are disentangled but we can
|
||
|
// still send pending messages.
|
||
|
eStateDisentangledForClose
|
||
|
};
|
||
|
|
||
|
void Initialize(const nsID& aUUID, const nsID& aDestinationUUID,
|
||
|
uint32_t aSequenceID, bool mNeutered, State aState,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
void ConnectToPBackground();
|
||
|
|
||
|
// Dispatch events from the Message Queue using a nsRunnable.
|
||
|
void Dispatch();
|
||
|
|
||
|
void StartDisentangling();
|
||
|
void Disentangle();
|
||
|
|
||
|
void RemoveDocFromBFCache();
|
||
|
|
||
|
void CloseInternal(bool aSoftly);
|
||
|
|
||
|
// This method is meant to keep alive the MessagePort when this object is
|
||
|
// creating the actor and until the actor is entangled.
|
||
|
// We release the object when the port is closed or disentangled.
|
||
|
void UpdateMustKeepAlive();
|
||
|
|
||
|
bool IsCertainlyAliveForCC() const override
|
||
|
{
|
||
|
return mIsKeptAlive;
|
||
|
}
|
||
|
|
||
|
nsAutoPtr<workers::WorkerFeature> mWorkerFeature;
|
||
|
|
||
|
RefPtr<DispatchEventRunnable> mDispatchRunnable;
|
||
|
|
||
|
RefPtr<MessagePortChild> mActor;
|
||
|
|
||
|
RefPtr<MessagePort> mUnshippedEntangledPort;
|
||
|
|
||
|
nsTArray<RefPtr<SharedMessagePortMessage>> mMessages;
|
||
|
nsTArray<RefPtr<SharedMessagePortMessage>> mMessagesForTheOtherPort;
|
||
|
|
||
|
nsAutoPtr<MessagePortIdentifier> mIdentifier;
|
||
|
|
||
|
uint64_t mInnerID;
|
||
|
|
||
|
State mState;
|
||
|
|
||
|
bool mMessageQueueEnabled;
|
||
|
|
||
|
bool mIsKeptAlive;
|
||
|
};
|
||
|
|
||
|
} // namespace dom
|
||
|
} // namespace mozilla
|
||
|
|
||
|
#endif // mozilla_dom_MessagePort_h
|