blob: 452d1297aa9df2cfdaa173652131b5f7a944d407 [file] [log] [blame]
// Copyright 2015 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.
#include <stdint.h>
#include "base/macros.h"
#include "ipc/ipc_export.h"
#include "ipc/ipc_message_attachment.h"
namespace IPC {
// This subclass of MessageAttachment requires an AttachmentBroker to be
// attached to a Chrome IPC message.
class IPC_EXPORT BrokerableAttachment : public MessageAttachment {
static const size_t kNonceSize = 16;
// An id uniquely identifies an attachment sent via a broker.
struct IPC_EXPORT AttachmentId {
uint8_t nonce[kNonceSize];
bool operator==(const AttachmentId& rhs) const {
for (size_t i = 0; i < kNonceSize; ++i) {
if (nonce[i] != rhs.nonce[i])
return false;
return true;
bool operator<(const AttachmentId& rhs) const {
for (size_t i = 0; i < kNonceSize; ++i) {
if (nonce[i] < rhs.nonce[i])
return true;
if (nonce[i] > rhs.nonce[i])
return false;
return false;
enum BrokerableType {
// The identifier is unique across all Chrome processes.
AttachmentId GetIdentifier() const;
// Whether the attachment still needs information from the broker before it
// can be used.
bool NeedsBrokering() const;
// Fills in the data of this instance with the data from |attachment|.
// This instance must require brokering, |attachment| must be brokered, and
// both instances must have the same identifier.
virtual void PopulateWithAttachment(
const BrokerableAttachment* attachment) = 0;
Type GetType() const override;
virtual BrokerableType GetBrokerableType() const = 0;
BrokerableAttachment(const AttachmentId& id, bool needs_brokering);
~BrokerableAttachment() override;
void SetNeedsBrokering(bool needs_brokering);
// This member uniquely identifies a BrokerableAttachment across all Chrome
// processes.
const AttachmentId id_;
// Whether the attachment still needs to be filled in by an AttachmentBroker.
bool needs_brokering_;
} // namespace IPC