File: channel_endpoint.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (61 lines) | stat: -rw-r--r-- 2,065 bytes parent folder | download | duplicates (7)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_BROWSER_API_MESSAGING_CHANNEL_ENDPOINT_H_
#define EXTENSIONS_BROWSER_API_MESSAGING_CHANNEL_ENDPOINT_H_

#include "base/memory/raw_ptr.h"
#include "extensions/browser/service_worker/worker_id.h"

#include "extensions/common/api/messaging/port_context.h"

namespace content {
class BrowserContext;
class RenderFrameHost;
}  // namespace content

namespace extensions {

// Represents an endpoint (tab, frame or worker) of a message channel in a
// render process or a native messaging host.
// TODO(crbug.com/40617215): Consolidate all classes/structs around extension
// message ports.
class ChannelEndpoint {
 public:
  // An endpoint for a renderer PortContext.
  ChannelEndpoint(content::BrowserContext* browser_context,
                  int render_process_id,
                  const PortContext& port_context);
  // An endpoint for a native message host.
  ChannelEndpoint(content::BrowserContext* browser_context);

  content::BrowserContext* browser_context() const { return browser_context_; }
  int render_process_id() const { return render_process_id_; }
  const PortContext& port_context() const { return port_context_; }

  bool is_for_service_worker() const;
  bool is_for_render_frame() const;
  bool is_for_native_host() const;

  // If the endpoint is a Service Worker, returns its worker id.
  // Only valid for worker endpoint.
  WorkerId GetWorkerId() const;

  // Returns the render frame if this endpoint points to a frame. Returns
  // nullptr if the frame is no longer alive.
  // Only valid for frame endpoint.
  content::RenderFrameHost* GetRenderFrameHost() const;

  // Returns whether the endpoint is currently live.
  bool IsValid() const;

 private:
  const raw_ptr<content::BrowserContext> browser_context_;
  const int render_process_id_;
  const PortContext port_context_;
};

}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_API_MESSAGING_CHANNEL_ENDPOINT_H_