summaryrefslogtreecommitdiffstats
path: root/dom/ipc/jsactor/JSProcessActorProtocol.h
blob: eab8876c351f545fc41603a3a8ca90d5663497c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/* -*- 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_JSProcessActorProtocol_h
#define mozilla_dom_JSProcessActorProtocol_h

#include "mozilla/dom/BrowsingContext.h"
#include "mozilla/dom/JSActorService.h"
#include "nsIURI.h"
#include "nsString.h"
#include "nsTArray.h"
#include "nsIObserver.h"

namespace mozilla {
class ErrorResult;

namespace dom {

struct ProcessActorOptions;
class JSProcessActorInfo;
class EventTarget;
class JSActorProtocolUtils;

/**
 * Object corresponding to a single process actor protocol
 *
 * This object also can act as a carrier for methods and other state related to
 * a single protocol managed by the JSActorService.
 */
class JSProcessActorProtocol final : public JSActorProtocol,
                                     public nsIObserver {
 public:
  NS_DECL_NSIOBSERVER
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(JSProcessActorProtocol, nsIObserver)

  static already_AddRefed<JSProcessActorProtocol> FromIPC(
      const JSProcessActorInfo& aInfo);
  JSProcessActorInfo ToIPC();

  static already_AddRefed<JSProcessActorProtocol> FromWebIDLOptions(
      const nsACString& aName, const ProcessActorOptions& aOptions,
      ErrorResult& aRv);

  struct ParentSide : public Sided {};

  struct ChildSide : public Sided {
    nsTArray<nsCString> mObservers;
  };

  const ParentSide& Parent() const override { return mParent; }
  const ChildSide& Child() const override { return mChild; }

  void AddObservers();
  void RemoveObservers();
  bool Matches(const nsACString& aRemoteType, ErrorResult& aRv);

 private:
  explicit JSProcessActorProtocol(const nsACString& aName) : mName(aName) {}
  bool RemoteTypePrefixMatches(const nsDependentCSubstring& aRemoteType);
  ~JSProcessActorProtocol() = default;

  nsCString mName;
  nsTArray<nsCString> mRemoteTypes;
  bool mIncludeParent = false;

  friend class JSActorProtocolUtils;

  ParentSide mParent;
  ChildSide mChild;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_JSProcessActorProtocol_h