tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

SharedWorker.h (2980B)

      1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
      2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
      3 /* This Source Code Form is subject to the terms of the Mozilla Public
      4 * License, v. 2.0. If a copy of the MPL was not distributed with this
      5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
      6 
      7 #ifndef mozilla_dom_workers_sharedworker_h__
      8 #define mozilla_dom_workers_sharedworker_h__
      9 
     10 #include "mozilla/DOMEventTargetHelper.h"
     11 #include "mozilla/dom/BindingDeclarations.h"
     12 #include "mozilla/dom/WorkerCommon.h"
     13 
     14 #ifdef XP_WIN
     15 #  undef PostMessage
     16 #endif
     17 
     18 class nsPIDOMWindowInner;
     19 
     20 namespace mozilla {
     21 class EventChainPreVisitor;
     22 
     23 namespace dom {
     24 class Event;
     25 class MessagePort;
     26 
     27 class StringOrWorkerOptions;
     28 struct WorkerOptions;
     29 
     30 class SharedWorkerChild;
     31 class TrustedScriptURLOrUSVString;
     32 
     33 /**
     34 * DOM binding. Holds a SharedWorkerChild. Must exist on the main thread because
     35 * we only allow top-level windows to create SharedWorkers.
     36 */
     37 class SharedWorker final : public DOMEventTargetHelper {
     38  using ErrorResult = mozilla::ErrorResult;
     39  using GlobalObject = mozilla::dom::GlobalObject;
     40 
     41  RefPtr<nsPIDOMWindowInner> mWindow;
     42  RefPtr<SharedWorkerChild> mActor;
     43  RefPtr<MessagePort> mMessagePort;
     44  nsTArray<RefPtr<Event>> mFrozenEvents;
     45  bool mFrozen;
     46 
     47 public:
     48  // TODO(bug 1749042): Mark as MOZ_CAN_RUN_SCRIPT when IDL constructors can be.
     49  MOZ_CAN_RUN_SCRIPT_BOUNDARY static already_AddRefed<SharedWorker> Constructor(
     50      const GlobalObject& aGlobal,
     51      const TrustedScriptURLOrUSVString& aScriptURL,
     52      const StringOrWorkerOptions& aOptions, ErrorResult& aRv);
     53 
     54  MessagePort* Port();
     55 
     56  bool IsFrozen() const { return mFrozen; }
     57 
     58  void QueueEvent(Event* aEvent);
     59 
     60  NS_DECL_ISUPPORTS_INHERITED
     61  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SharedWorker, DOMEventTargetHelper)
     62 
     63  IMPL_EVENT_HANDLER(error)
     64 
     65  virtual JSObject* WrapObject(JSContext* aCx,
     66                               JS::Handle<JSObject*> aGivenProto) override;
     67 
     68  void GetEventTargetParent(EventChainPreVisitor& aVisitor) override;
     69 
     70  void DisconnectFromOwner() override;
     71 
     72  void ErrorPropagation(nsresult aError);
     73 
     74  // Methods called from the window.
     75 
     76  void Close();
     77 
     78  void Suspend();
     79 
     80  void Resume();
     81 
     82  void Freeze();
     83 
     84  void Thaw();
     85 
     86 private:
     87  MOZ_CAN_RUN_SCRIPT static already_AddRefed<SharedWorker> Constructor(
     88      const GlobalObject& aGlobal,
     89      const TrustedScriptURLOrUSVString& aScriptURL,
     90      const WorkerOptions& aOptions, ErrorResult& aRv);
     91 
     92  SharedWorker(nsPIDOMWindowInner* aWindow, SharedWorkerChild* aActor,
     93               MessagePort* aMessagePort);
     94 
     95  // This class is reference-counted and will be destroyed from Release().
     96  ~SharedWorker();
     97 
     98  // Only called by MessagePort.
     99  void PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
    100                   const Sequence<JSObject*>& aTransferable, ErrorResult& aRv);
    101 };
    102 
    103 }  // namespace dom
    104 }  // namespace mozilla
    105 
    106 #endif  // mozilla_dom_workers_sharedworker_h__