dom/base/MessageManagerCallback.h

   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 dom_base_MessageManagerCallback_h__
   8 #define dom_base_MessageManagerCallback_h__
   9
  10 #include "nsError.h"
  11 #include "nsStringFwd.h"
  12 #include "nsTArrayForwardDeclare.h"
  13
  14 namespace mozilla {
  15
  16 class ErrorResult;
  17
  18 namespace dom {
  19
  20 class ClonedMessageData;
  21 class ContentChild;
  22 class ContentParent;
  23 class ProcessMessageManager;
  24
  25 namespace ipc {
  26
  27 class StructuredCloneData;
  28
  29 class MessageManagerCallback {
  30  public:
  31   virtual ~MessageManagerCallback() = default;
  32
  33   virtual bool DoLoadMessageManagerScript(const nsAString& aURL,
  34                                           bool aRunInGlobalScope) {
  35     return true;
  36   }
  37
  38   virtual bool DoSendBlockingMessage(const nsAString& aMessage,
  39                                      StructuredCloneData& aData,
  40                                      nsTArray<StructuredCloneData>* aRetVal) {
  41     return true;
  42   }
  43
  44   virtual nsresult DoSendAsyncMessage(const nsAString& aMessage,
  45                                       StructuredCloneData& aData) {
  46     return NS_OK;
  47   }
  48
  49   virtual mozilla::dom::ProcessMessageManager* GetProcessMessageManager()
  50       const {
  51     return nullptr;
  52   }
  53
  54   virtual void DoGetRemoteType(nsACString& aRemoteType,
  55                                ErrorResult& aError) const;
  56
  57  protected:
  58   bool BuildClonedMessageData(StructuredCloneData& aData,
  59                               ClonedMessageData& aClonedData);
  60 };
  61
  62 void UnpackClonedMessageData(const ClonedMessageData& aClonedData,
  63                              StructuredCloneData& aData);
  64
  65 }  // namespace ipc
  66 }  // namespace dom
  67 }  // namespace mozilla
  68
  69 #endif