author Ben Kelly <>
Mon, 19 Feb 2018 12:06:19 -0800
changeset 404416 a2ebde19d2781370ea487c93ce9a7a0c7d6b263f
parent 401758 6b5ed759f753d1f204be3826ab56bb33bb2d2611
child 404682 9a2fc66acc13134ec5025fa65ed226e196e30a2e
permissions -rw-r--r--
Bug 1439099 P3 Remove ServiceWorker::MatchesDescriptor() in favor of Descriptor().Matches(). r=asuth

/* -*- 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 */

#ifndef mozilla_dom_serviceworker_h__
#define mozilla_dom_serviceworker_h__

#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/ServiceWorkerDescriptor.h"

#ifdef XP_WIN
#undef PostMessage

class nsIGlobalObject;

namespace mozilla {
namespace dom {

ServiceWorkerVisible(JSContext* aCx, JSObject* aObj);

class ServiceWorker final : public DOMEventTargetHelper
  // Abstract interface for the internal representation of the
  // ServiceWorker object.
  class Inner
    // This will be called when a DOM ServiceWorker object is
    // created and takes a strong ref to the Inner object.
    // RemoveServiceWorker() is guaranteed to be called on the
    // current thread before the ServiceWorker is destroyed.
    // In addition, the Inner object should check to see if
    // the ServiceWorker's state is correct.  If not, it should
    // be updated automatically by calling SetState().  This is
    // necessary to handle race conditions where the DOM
    // ServiceWorker object is created while the state is being
    // updated in another process.
    virtual void
    AddServiceWorker(ServiceWorker* aWorker) = 0;

    // This is called when the DOM ServiceWorker object is
    // destroyed and drops its ref to the Inner object.
    virtual void
    RemoveServiceWorker(ServiceWorker* aWorker) = 0;

    virtual void
    PostMessage(nsIGlobalObject* aGlobal,
                JSContext* aCx, JS::Handle<JS::Value> aMessage,
                const Sequence<JSObject*>& aTransferable,
                ErrorResult& aRv) = 0;




  static already_AddRefed<ServiceWorker>
  Create(nsIGlobalObject* aOwner, const ServiceWorkerDescriptor& aDescriptor);

  virtual JSObject*
  WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;

  State() const;

  SetState(ServiceWorkerState aState);

  GetScriptURL(nsString& aURL) const;

  PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
              const Sequence<JSObject*>& aTransferable, ErrorResult& aRv);

  const ServiceWorkerDescriptor&
  Descriptor() const;

  DisconnectFromOwner() override;

  ServiceWorker(nsIGlobalObject* aWindow,
                const ServiceWorkerDescriptor& aDescriptor,
                Inner* aInner);

  // This class is reference-counted and will be destroyed from Release().

  ServiceWorkerDescriptor mDescriptor;
  const RefPtr<Inner> mInner;

} // namespace dom
} // namespace mozilla

#endif // mozilla_dom_serviceworker_h__