dom/base/MessagePort.h

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/dom/base/MessagePort.h	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,113 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 +
     1.9 +#ifndef mozilla_dom_MessagePort_h
    1.10 +#define mozilla_dom_MessagePort_h
    1.11 +
    1.12 +#include "mozilla/Attributes.h"
    1.13 +#include "mozilla/DOMEventTargetHelper.h"
    1.14 +
    1.15 +class nsPIDOMWindow;
    1.16 +
    1.17 +namespace mozilla {
    1.18 +namespace dom {
    1.19 +
    1.20 +class DispatchEventRunnable;
    1.21 +class PostMessageRunnable;
    1.22 +
    1.23 +class MessagePortBase : public DOMEventTargetHelper
    1.24 +{
    1.25 +protected:
    1.26 +  MessagePortBase(nsPIDOMWindow* aWindow);
    1.27 +  MessagePortBase();
    1.28 +
    1.29 +public:
    1.30 +
    1.31 +  virtual void
    1.32 +  PostMessageMoz(JSContext* aCx, JS::Handle<JS::Value> aMessage,
    1.33 +                const Optional<Sequence<JS::Value>>& aTransferable,
    1.34 +                ErrorResult& aRv) = 0;
    1.35 +
    1.36 +  virtual void
    1.37 +  Start() = 0;
    1.38 +
    1.39 +  virtual void
    1.40 +  Close() = 0;
    1.41 +
    1.42 +  // The 'message' event handler has to call |Start()| method, so we
    1.43 +  // cannot use IMPL_EVENT_HANDLER macro here.
    1.44 +  virtual EventHandlerNonNull*
    1.45 +  GetOnmessage() = 0;
    1.46 +
    1.47 +  virtual void
    1.48 +  SetOnmessage(EventHandlerNonNull* aCallback) = 0;
    1.49 +
    1.50 +  // Duplicate this message port. This method is used by the Structured Clone
    1.51 +  // Algorithm and makes the new MessagePort active with the entangled
    1.52 +  // MessagePort of this object.
    1.53 +  virtual already_AddRefed<MessagePortBase>
    1.54 +  Clone() = 0;
    1.55 +};
    1.56 +
    1.57 +class MessagePort MOZ_FINAL : public MessagePortBase
    1.58 +{
    1.59 +  friend class DispatchEventRunnable;
    1.60 +  friend class PostMessageRunnable;
    1.61 +
    1.62 +public:
    1.63 +  NS_DECL_ISUPPORTS_INHERITED
    1.64 +  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(MessagePort,
    1.65 +                                           DOMEventTargetHelper)
    1.66 +
    1.67 +  MessagePort(nsPIDOMWindow* aWindow);
    1.68 +  ~MessagePort();
    1.69 +
    1.70 +  virtual JSObject*
    1.71 +  WrapObject(JSContext* aCx) MOZ_OVERRIDE;
    1.72 +
    1.73 +  virtual void
    1.74 +  PostMessageMoz(JSContext* aCx, JS::Handle<JS::Value> aMessage,
    1.75 +                 const Optional<Sequence<JS::Value>>& aTransferable,
    1.76 +                 ErrorResult& aRv) MOZ_OVERRIDE;
    1.77 +
    1.78 +  virtual void
    1.79 +  Start() MOZ_OVERRIDE;
    1.80 +
    1.81 +  virtual void
    1.82 +  Close() MOZ_OVERRIDE;
    1.83 +
    1.84 +  virtual EventHandlerNonNull*
    1.85 +  GetOnmessage() MOZ_OVERRIDE;
    1.86 +
    1.87 +  virtual void
    1.88 +  SetOnmessage(EventHandlerNonNull* aCallback) MOZ_OVERRIDE;
    1.89 +
    1.90 +  // Non WebIDL methods
    1.91 +
    1.92 +  // This method entangles this MessagePort with another one.
    1.93 +  // If it is already entangled, it's disentangled first and enatangle to the
    1.94 +  // new one.
    1.95 +  void
    1.96 +  Entangle(MessagePort* aMessagePort);
    1.97 +
    1.98 +  virtual already_AddRefed<MessagePortBase>
    1.99 +  Clone() MOZ_OVERRIDE;
   1.100 +
   1.101 +private:
   1.102 +  // Dispatch events from the Message Queue using a nsRunnable.
   1.103 +  void Dispatch();
   1.104 +
   1.105 +  nsRefPtr<DispatchEventRunnable> mDispatchRunnable;
   1.106 +
   1.107 +  nsRefPtr<MessagePort> mEntangledPort;
   1.108 +
   1.109 +  nsTArray<nsRefPtr<PostMessageRunnable> > mMessageQueue;
   1.110 +  bool mMessageQueueEnabled;
   1.111 +};
   1.112 +
   1.113 +} // namespace dom
   1.114 +} // namespace mozilla
   1.115 +
   1.116 +#endif // mozilla_dom_MessagePort_h

mercurial