mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-07 03:38:51 +02:00
34daf589ca
The ExtensionPort represents the webidl definitions of the runtime.Port WebExtensions API object. A webidl dictionary will represent the serializable definition of the port properties, sent from the API request handler to provide all the internal properties needed to create an instance of the ExtensionPort webidl interface on the worker thread (which will be returned to the extension code as the return value of the runtime.connect/connectNative methods and as a parameter of the calls to the runtime.onConnect API event listeners). Depends on D84684 Differential Revision: https://phabricator.services.mozilla.com/D84685
87 lines
2.7 KiB
C++
87 lines
2.7 KiB
C++
/* -*- 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_extensions_ExtensionPort_h
|
|
#define mozilla_extensions_ExtensionPort_h
|
|
|
|
#include "js/TypeDecls.h"
|
|
#include "mozilla/dom/BindingDeclarations.h"
|
|
#include "nsWrapperCache.h"
|
|
|
|
#include "ExtensionAPIBase.h"
|
|
|
|
class nsIGlobalObject;
|
|
|
|
namespace mozilla {
|
|
|
|
class ErrorResult;
|
|
|
|
namespace dom {
|
|
struct ExtensionPortDescriptor;
|
|
}
|
|
|
|
namespace extensions {
|
|
|
|
class ExtensionEventManager;
|
|
|
|
class ExtensionPort final : public nsISupports,
|
|
public nsWrapperCache,
|
|
public ExtensionAPIBase {
|
|
nsCOMPtr<nsIGlobalObject> mGlobal;
|
|
RefPtr<ExtensionEventManager> mOnDisconnectEventMgr;
|
|
RefPtr<ExtensionEventManager> mOnMessageEventMgr;
|
|
UniquePtr<dom::ExtensionPortDescriptor> mPortDescriptor;
|
|
|
|
~ExtensionPort() = default;
|
|
ExtensionPort(nsIGlobalObject* aGlobal,
|
|
UniquePtr<dom::ExtensionPortDescriptor> aPortDescriptor);
|
|
|
|
protected:
|
|
// ExtensionAPIBase methods
|
|
nsIGlobalObject* GetGlobalObject() const override { return mGlobal; }
|
|
|
|
nsString GetAPINamespace() const override { return u"runtime"_ns; }
|
|
|
|
nsString GetAPIObjectType() const override { return u"Port"_ns; }
|
|
|
|
nsString GetAPIObjectId() const override;
|
|
|
|
public:
|
|
static already_AddRefed<ExtensionPort> Create(
|
|
nsIGlobalObject* aGlobal, JS::Handle<JS::Value> aDescriptorValue,
|
|
ErrorResult& aRv);
|
|
|
|
// nsWrapperCache interface methods
|
|
JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
nsIGlobalObject* GetParentObject() const;
|
|
|
|
ExtensionEventManager* OnDisconnect();
|
|
ExtensionEventManager* OnMessage();
|
|
|
|
void GetName(nsAString& aString);
|
|
void GetError(JSContext* aCx, JS::MutableHandle<JSObject*> aResult) {
|
|
// TODO: this is currently just a placeholder, should be filled in
|
|
// with the actual implementation (which may send to the API request
|
|
// handler an API request to get the property value from the port object
|
|
// representation that lives on the main thread).
|
|
}
|
|
void GetSender(JSContext* aCx, JS::MutableHandle<JSObject*> aResult) {
|
|
// TODO: this is currently just a placeholder, needed to please the
|
|
// webidl binding which excepts this property to always return
|
|
// an object.
|
|
aResult.set(JS_NewPlainObject(aCx));
|
|
};
|
|
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(ExtensionPort)
|
|
};
|
|
|
|
} // namespace extensions
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_extensions_ExtensionPort_h
|