File: message_target.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,218 bytes parent folder | download | duplicates (8)
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
// Copyright 2017 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_RENDERER_API_MESSAGING_MESSAGE_TARGET_H_
#define EXTENSIONS_RENDERER_API_MESSAGING_MESSAGE_TARGET_H_

#include <optional>
#include <string>

#include "extensions/common/extension_id.h"

namespace extensions {

// Represents a target of an extension message. This could be:
// 1. An Extension. Either an extension page is messaging another extension
//    page (e.g., popup messaging background page), a content script is
//    messaging an extension page, or a separate extension or web page is
//    messaging an extension page. Any calls to chrome.runtime.connect() or
//    chrome.runtime.sendMessage() target extensions.
// 2. A tab (i.e., a content script running in a web page). Any calls to
//    chrome.tabs.connect() or chrome.tabs.sendMessage() target tabs.
// 3. A native application. An extension is using native messaging to
//    communicate with a third-party application. Any calls to
//    chrome.runtime.connectNative() or chrome.runtime.sendNativeMessage()
//    target native applications.
struct MessageTarget {
  enum Type {
    TAB,
    EXTENSION,
    NATIVE_APP,
  };

  static MessageTarget ForTab(int tab_id, int frame_id);
  static MessageTarget ForTab(int tab_id,
                              int frame_id,
                              const std::string& document_id);
  static MessageTarget ForExtension(const ExtensionId& extension_id);
  static MessageTarget ForNativeApp(const std::string& native_app_name);

  MessageTarget(MessageTarget&& other);
  MessageTarget(const MessageTarget& other);
  ~MessageTarget();

  Type type;
  // Only valid for Type::EXTENSION.
  std::optional<ExtensionId> extension_id;
  // Only valid for Type::NATIVE_APP.
  std::optional<std::string> native_application_name;
  // Only valid for Type::TAB.
  std::optional<int> tab_id;
  std::optional<int> frame_id;
  std::optional<std::string> document_id;

  bool operator==(const MessageTarget& other) const;

 private:
  MessageTarget(Type type);
};

}  // namespace extensions

#endif  // EXTENSIONS_RENDERER_API_MESSAGING_MESSAGE_TARGET_H_