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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_MOJO_HEAP_MOJO_RECEIVER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_MOJO_HEAP_MOJO_RECEIVER_H_
#include "base/gtest_prod_util.h"
#include "base/task/sequenced_task_runner.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "third_party/blink/renderer/platform/context_lifecycle_observer.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/prefinalizer.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_wrapper_mode.h"
#include "third_party/blink/renderer/platform/mojo/mojo_binding_context.h"
namespace blink {
// HeapMojoReceiver is a wrapper for mojo::Receiver to be owned by a
// garbage-collected object. Blink is expected to use HeapMojoReceiver by
// default. HeapMojoReceiver must be associated with context.
// HeapMojoReceiver's constructor takes context as a mandatory parameter.
// HeapMojoReceiver resets the mojo connection when 1) the owner object is
// garbage-collected and 2) the associated ExecutionContext is detached.
// TODO(crbug.com/1058076) HeapMojoWrapperMode should be removed once we ensure
// that the interface is not used after ContextDestroyed().
template <typename Interface,
typename Owner,
HeapMojoWrapperMode Mode = HeapMojoWrapperMode::kWithContextObserver>
class HeapMojoReceiver {
DISALLOW_NEW();
public:
HeapMojoReceiver(Owner* owner, ContextLifecycleNotifier* context)
: wrapper_(MakeGarbageCollected<Wrapper>(owner, context)) {
static_assert(std::is_base_of<Interface, Owner>::value,
"Owner should implement Interface");
static_assert(IsGarbageCollectedType<Owner>::value,
"Owner needs to be a garbage collected object");
}
HeapMojoReceiver(const HeapMojoReceiver&) = delete;
HeapMojoReceiver& operator=(const HeapMojoReceiver&) = delete;
// Methods to redirect to mojo::Receiver:
bool is_bound() const { return wrapper_->receiver().is_bound(); }
void reset() { wrapper_->receiver().reset(); }
void ResetWithReason(uint32_t custom_reason_code,
const std::string& description) {
wrapper_->receiver().ResetWithReason(custom_reason_code, description);
}
void set_disconnect_handler(base::OnceClosure handler) {
wrapper_->receiver().set_disconnect_handler(std::move(handler));
}
void set_disconnect_with_reason_handler(
mojo::ConnectionErrorWithReasonCallback error_handler) {
wrapper_->receiver().set_disconnect_with_reason_handler(
std::move(error_handler));
}
[[nodiscard]] mojo::PendingRemote<Interface> BindNewPipeAndPassRemote(
scoped_refptr<base::SequencedTaskRunner> task_runner) {
DCHECK(task_runner);
return wrapper_->receiver().BindNewPipeAndPassRemote(
std::move(task_runner));
}
void Bind(mojo::PendingReceiver<Interface> pending_receiver,
scoped_refptr<base::SequencedTaskRunner> task_runner) {
DCHECK(task_runner);
wrapper_->receiver().Bind(std::move(pending_receiver),
std::move(task_runner));
}
bool WaitForIncomingCall() {
return wrapper_->receiver().WaitForIncomingCall();
}
void SetFilter(std::unique_ptr<mojo::MessageFilter> filter) {
wrapper_->receiver().SetFilter(std::move(filter));
}
void Trace(Visitor* visitor) const { visitor->Trace(wrapper_); }
private:
FRIEND_TEST_ALL_PREFIXES(HeapMojoReceiverGCWithContextObserverTest,
NoResetOnConservativeGC);
// Garbage collected wrapper class to add a prefinalizer.
class Wrapper final : public GarbageCollected<Wrapper>,
public ContextLifecycleObserver {
USING_PRE_FINALIZER(Wrapper, Dispose);
public:
Wrapper(Owner* owner, ContextLifecycleNotifier* notifier)
: owner_(owner), receiver_(owner) {
SetContextLifecycleNotifier(notifier);
}
void Trace(Visitor* visitor) const override {
visitor->Trace(owner_);
ContextLifecycleObserver::Trace(visitor);
}
void Dispose() { receiver_.reset(); }
mojo::Receiver<Interface>& receiver() { return receiver_; }
// ContextLifecycleObserver methods
void ContextDestroyed() override {
if (Mode == HeapMojoWrapperMode::kWithContextObserver)
receiver_.reset();
}
private:
Member<Owner> owner_;
mojo::Receiver<Interface> receiver_;
};
Member<Wrapper> wrapper_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_MOJO_HEAP_MOJO_RECEIVER_H_
|