third_party/blink/renderer/core/messaging/blink_transferable_message.h

// Copyright 2017 The Chromium Authors. All rights reserved.
// 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_CORE_MESSAGING_BLINK_TRANSFERABLE_MESSAGE_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_MESSAGING_BLINK_TRANSFERABLE_MESSAGE_H_

#include "base/macros.h"
#include "third_party/blink/public/common/messaging/message_port_channel.h"
#include "third_party/blink/public/common/messaging/transferable_message.h"
#include "third_party/blink/public/mojom/messaging/user_activation_snapshot.mojom-blink.h"
#include "third_party/blink/renderer/bindings/core/v8/serialization/serialized_script_value.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/messaging/blink_cloneable_message.h"
#include "third_party/blink/renderer/platform/cross_thread_copier.h"

namespace blink {

// This struct represents messages as they are posted over a message port. This
// type can be serialized as a blink::mojom::TransferableMessage struct.
// This is the renderer-side equivalent of blink::TransferableMessage, where
// this struct uses blink types, while the other struct uses std:: types.
struct CORE_EXPORT BlinkTransferableMessage : BlinkCloneableMessage {
  BlinkTransferableMessage();
  ~BlinkTransferableMessage();

  BlinkTransferableMessage(BlinkTransferableMessage&&);
  BlinkTransferableMessage& operator=(BlinkTransferableMessage&&);

  Vector<MessagePortChannel> ports;

  bool has_user_gesture = false;

  mojom::blink::UserActivationSnapshotPtr user_activation;

  bool transfer_user_activation = false;

 private:
  DISALLOW_COPY_AND_ASSIGN(BlinkTransferableMessage);
};

CORE_EXPORT BlinkTransferableMessage
    ToBlinkTransferableMessage(TransferableMessage);
// Returned message will still be backed by the SerializedScriptValue in the
// input message, so is only valid as long as that SerializedScriptValue is
// alive. Call EnsureDataIsOwned on the returned message if you need it to live
// longer.
CORE_EXPORT TransferableMessage ToTransferableMessage(BlinkTransferableMessage);

template <>
struct CrossThreadCopier<BlinkTransferableMessage> {
  STATIC_ONLY(CrossThreadCopier);
  using Type = BlinkTransferableMessage;
  static Type Copy(Type pointer) {
    return pointer;  // This is in fact a move.
  }
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_MESSAGING_BLINK_TRANSFERABLE_MESSAGE_H_