File: native_message_host.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 (67 lines) | stat: -rw-r--r-- 2,261 bytes parent folder | download | duplicates (5)
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
64
65
66
67
// Copyright 2014 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_NATIVE_MESSAGE_HOST_H_
#define EXTENSIONS_BROWSER_API_MESSAGING_NATIVE_MESSAGE_HOST_H_

#include <memory>
#include <string>

#include "base/task/single_thread_task_runner.h"
#include "ui/gfx/native_widget_types.h"

namespace content {
class BrowserContext;
}  // namespace content

namespace extensions {

// An interface for receiving messages from MessageService (Chrome) using the
// Native Messaging API.  A NativeMessageHost object hosts a native component,
// which can run in the browser-process or in a separate process (See
// NativeMessageProcessHost).
class NativeMessageHost {
 public:
  static const char kFailedToStartError[];
  static const char kInvalidNameError[];
  static const char kNativeHostExited[];
  static const char kNotFoundError[];
  static const char kForbiddenError[];
  static const char kHostInputOutputError[];

  // Callback interface for receiving messages from the native host.
  class Client {
   public:
    virtual ~Client() {}

    // Called on the UI thread.
    virtual void PostMessageFromNativeHost(const std::string& message) = 0;
    virtual void CloseChannel(const std::string& error_message) = 0;
  };

  // Creates the NativeMessageHost based on the `native_host_name`.
  static std::unique_ptr<NativeMessageHost> Create(
      content::BrowserContext* browser_context,
      gfx::NativeView native_view,
      const std::string& source_extension_id,
      const std::string& native_host_name,
      bool allow_user_level,
      std::string* error);

  virtual ~NativeMessageHost() {}

  // Called when a message is received from MessageService (Chrome).
  virtual void OnMessage(const std::string& message) = 0;

  // Sets the client to start receiving messages from the native host.
  virtual void Start(Client* client) = 0;

  // Returns the task runner that the host runs on. The Client should only
  // invoke OnMessage() on this task runner.
  virtual scoped_refptr<base::SingleThreadTaskRunner> task_runner() const = 0;
};

}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_API_MESSAGING_NATIVE_MESSAGE_HOST_H_