content/public/browser/service_worker_client_info.h

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_PUBLIC_BROWSER_SERVICE_WORKER_CLIENT_INFO_H_
#define CONTENT_PUBLIC_BROWSER_SERVICE_WORKER_CLIENT_INFO_H_

#include "content/common/content_export.h"
#include "content/public/browser/global_routing_id.h"
#include "content/public/browser/render_frame_host.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "third_party/blink/public/common/tokens/multi_token.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/public/mojom/service_worker/service_worker_client.mojom.h"

namespace content {

using DedicatedOrSharedWorkerToken =
    blink::MultiToken<blink::DedicatedWorkerToken, blink::SharedWorkerToken>;

// Holds information about a single service worker client:
// https://w3c.github.io/ServiceWorker/#client
class CONTENT_EXPORT ServiceWorkerClientInfo {
 public:
  ServiceWorkerClientInfo();
  explicit ServiceWorkerClientInfo(
      const blink::DedicatedWorkerToken& dedicated_worker_token);
  explicit ServiceWorkerClientInfo(
      const blink::SharedWorkerToken& shared_worker_token);
  explicit ServiceWorkerClientInfo(
      const DedicatedOrSharedWorkerToken& worker_token);

  ServiceWorkerClientInfo(const ServiceWorkerClientInfo& other);
  ServiceWorkerClientInfo& operator=(const ServiceWorkerClientInfo& other);

  ~ServiceWorkerClientInfo();

  // Returns the type of this client.
  blink::mojom::ServiceWorkerClientType type() const { return type_; }

  GlobalRenderFrameHostId GetRenderFrameHostId() const;
  void SetRenderFrameHostId(
      const GlobalRenderFrameHostId& render_frame_host_id);

  // Returns the corresponding DedicatedWorkerToken. This should only be called
  // if "type() == blink::mojom::ServiceWorkerClientType::kDedicatedWorker".
  blink::DedicatedWorkerToken GetDedicatedWorkerToken() const;

  // Returns the corresponding SharedWorkerToken. This should only be called
  // if "type() == blink::mojom::ServiceWorkerClientType::kSharedWorker".
  blink::SharedWorkerToken GetSharedWorkerToken() const;

 private:
  // The client type.
  blink::mojom::ServiceWorkerClientType type_;

  // For a window client.
  // Currently, there is a time lag between when ServiceWorkerClientInfo is
  // created and `render_frame_host_id_` is set.
  // TODO(asamidoi): Set GlobalRenderFrameHostId in the constructor of
  // ServiceWorkerClientInfo and remove SetRenderFrameHostId().
  GlobalRenderFrameHostId render_frame_host_id_;

  // The ID of the client, if it is a worker.
  absl::optional<DedicatedOrSharedWorkerToken> worker_token_;
};

}  // namespace content

#endif  // CONTENT_PUBLIC_BROWSER_SERVICE_WORKER_CLIENT_INFO_H_