BroadcastChannel.h

Enable keyboard shortcuts

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

#define mozilla_dom_BroadcastChannel_h

#include "mozilla/Attributes.h"

#include "mozilla/DOMEventTargetHelper.h"

#include "nsTArray.h"

#include "mozilla/RefPtr.h"

class nsIGlobalObject;

namespace mozilla {

namespace ipc {

class PrincipalInfo;

}  // namespace ipc

namespace dom {

class BroadcastChannelChild;

class RefMessageBodyService;

class WorkerRef;

class BroadcastChannel final : public DOMEventTargetHelper {

  friend class BroadcastChannelChild;

  using PrincipalInfo = mozilla::ipc::PrincipalInfo;

 public:

  NS_DECL_ISUPPORTS_INHERITED

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(BroadcastChannel,

                                           DOMEventTargetHelper)

  virtual JSObject* WrapObject(JSContext* aCx,

                               JS::Handle<JSObject*> aGivenProto) override;

  static already_AddRefed<BroadcastChannel> Constructor(

      const GlobalObject& aGlobal, const nsAString& aChannel, ErrorResult& aRv);

  void GetName(nsAString& aName) const { aName = mChannel; }

  void PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,

                   ErrorResult& aRv);

  void Close();

  IMPL_EVENT_HANDLER(message)

  IMPL_EVENT_HANDLER(messageerror)

  void Shutdown();

 private:

  BroadcastChannel(nsIGlobalObject* aGlobal, const nsAString& aChannel,

                   const nsID& aPortUUID);

  ~BroadcastChannel();

  void MessageReceived(const MessageData& aData);

  void MessageDelivered(const nsID& aMessageID, uint32_t aOtherBCs);

  void RemoveDocFromBFCache();

  void DisconnectFromOwner() override;

  void DispatchError(JSContext* aCx);

  RefPtr<BroadcastChannelChild> mActor;

  RefPtr<RefMessageBodyService> mRefMessageBodyService;

  RefPtr<WorkerRef> mWorkerRef;

  nsString mChannel;

  nsString mOriginForEvents;

  enum { StateActive, StateClosed } mState;

  // This ID is used to identify the messages-by-reference sent by this port.

  // See RefMessageBodyService.

  nsID mPortUUID;

};

}  // namespace dom

}  // namespace mozilla

#endif  // mozilla_dom_BroadcastChannel_h