Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(208)

Side by Side Diff: content/public/common/mojo_shell_connection.h

Issue 2118083002: ShellClient -> Service (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@mus2
Patch Set: . Created 4 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « content/public/common/mojo_application_info.cc ('k') | content/public/test/test_mojo_app.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright 2016 The Chromium Authors. All rights reserved. 1 // Copyright 2016 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_ 5 #ifndef CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_
6 #define CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_ 6 #define CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_
7 7
8 #include <memory> 8 #include <memory>
9 9
10 #include "base/callback_forward.h" 10 #include "base/callback_forward.h"
11 #include "content/common/content_export.h" 11 #include "content/common/content_export.h"
12 #include "content/public/common/mojo_application_info.h" 12 #include "content/public/common/mojo_application_info.h"
13 #include "services/shell/public/cpp/identity.h" 13 #include "services/shell/public/cpp/identity.h"
14 #include "services/shell/public/interfaces/shell_client.mojom.h" 14 #include "services/shell/public/interfaces/service.mojom.h"
15 15
16 namespace shell { 16 namespace shell {
17 class Connection; 17 class Connection;
18 class Connector; 18 class Connector;
19 class ShellConnection; 19 class ShellConnection;
20 } 20 }
21 21
22 namespace content { 22 namespace content {
23 23
24 // Encapsulates a connection to a //services/shell. 24 // Encapsulates a connection to a //services/shell.
25 // Access a global instance on the thread the ShellConnection was bound by 25 // Access a global instance on the thread the ShellConnection was bound by
26 // calling Holder::Get(). 26 // calling Holder::Get().
27 // Clients can add shell::ShellClient implementations whose exposed interfaces 27 // Clients can add shell::Service implementations whose exposed interfaces
28 // will be exposed to inbound connections to this object's ShellClient. 28 // will be exposed to inbound connections to this object's Service.
29 // Alternatively clients can define named services that will be constructed when 29 // Alternatively clients can define named services that will be constructed when
30 // requests for those service names are received. 30 // requests for those service names are received.
31 // Clients must call any of the registration methods when receiving 31 // Clients must call any of the registration methods when receiving
32 // ContentBrowserClient::RegisterInProcessMojoApplications(). 32 // ContentBrowserClient::RegisterInProcessMojoApplications().
33 class CONTENT_EXPORT MojoShellConnection { 33 class CONTENT_EXPORT MojoShellConnection {
34 public: 34 public:
35 using ShellClientRequestHandler = 35 using ServiceRequestHandler =
36 base::Callback<void(shell::mojom::ShellClientRequest)>; 36 base::Callback<void(shell::mojom::ServiceRequest)>;
37 using Factory = base::Callback<std::unique_ptr<MojoShellConnection>(void)>; 37 using Factory = base::Callback<std::unique_ptr<MojoShellConnection>(void)>;
38 38
39 // Stores an instance of |connection| in TLS for the current process. Must be 39 // Stores an instance of |connection| in TLS for the current process. Must be
40 // called on the thread the connection was created on. 40 // called on the thread the connection was created on.
41 static void SetForProcess(std::unique_ptr<MojoShellConnection> connection); 41 static void SetForProcess(std::unique_ptr<MojoShellConnection> connection);
42 42
43 // Returns the per-process instance, or nullptr if the Shell connection has 43 // Returns the per-process instance, or nullptr if the Shell connection has
44 // not yet been bound. Must be called on the thread the connection was created 44 // not yet been bound. Must be called on the thread the connection was created
45 // on. 45 // on.
46 static MojoShellConnection* GetForProcess(); 46 static MojoShellConnection* GetForProcess();
47 47
48 // Destroys the per-process instance. Must be called on the thread the 48 // Destroys the per-process instance. Must be called on the thread the
49 // connection was created on. 49 // connection was created on.
50 static void DestroyForProcess(); 50 static void DestroyForProcess();
51 51
52 virtual ~MojoShellConnection(); 52 virtual ~MojoShellConnection();
53 53
54 // Sets the factory used to create the MojoShellConnection. This must be 54 // Sets the factory used to create the MojoShellConnection. This must be
55 // called before the MojoShellConnection has been created. 55 // called before the MojoShellConnection has been created.
56 static void SetFactoryForTest(Factory* factory); 56 static void SetFactoryForTest(Factory* factory);
57 57
58 // Creates a MojoShellConnection from |request|. 58 // Creates a MojoShellConnection from |request|.
59 static std::unique_ptr<MojoShellConnection> Create( 59 static std::unique_ptr<MojoShellConnection> Create(
60 shell::mojom::ShellClientRequest request); 60 shell::mojom::ServiceRequest request);
61 61
62 // Returns the bound shell::ShellConnection object. 62 // Returns the bound shell::ShellConnection object.
63 // TODO(rockot): remove. 63 // TODO(rockot): remove.
64 virtual shell::ShellConnection* GetShellConnection() = 0; 64 virtual shell::ShellConnection* GetShellConnection() = 0;
65 65
66 // Returns the shell::Connector received via this connection's ShellClient 66 // Returns the shell::Connector received via this connection's Service
67 // implementation. Use this to initiate connections as this object's Identity. 67 // implementation. Use this to initiate connections as this object's Identity.
68 virtual shell::Connector* GetConnector() = 0; 68 virtual shell::Connector* GetConnector() = 0;
69 69
70 // Returns this connection's identity with the shell. Connections initiated 70 // Returns this connection's identity with the shell. Connections initiated
71 // via the shell::Connector returned by GetConnector() will use this. 71 // via the shell::Connector returned by GetConnector() will use this.
72 virtual const shell::Identity& GetIdentity() const = 0; 72 virtual const shell::Identity& GetIdentity() const = 0;
73 73
74 // Sets a closure that is called when the connection is lost. Note that 74 // Sets a closure that is called when the connection is lost. Note that
75 // connection may already have been closed, in which case |closure| will be 75 // connection may already have been closed, in which case |closure| will be
76 // run immediately before returning from this function. 76 // run immediately before returning from this function.
77 virtual void SetConnectionLostClosure(const base::Closure& closure) = 0; 77 virtual void SetConnectionLostClosure(const base::Closure& closure) = 0;
78 78
79 // Allows the caller to expose interfaces to the caller using the identity of 79 // Allows the caller to expose interfaces to the caller using the identity of
80 // this object's ShellClient. As distinct from AddEmbeddedService() and 80 // this object's Service. As distinct from MergeService() and
81 // AddShellClientRequestHandler() which specify unique identities for the 81 // AddServiceRequestHandler() which specify unique identities for the
82 // registered services. 82 // registered services.
83 virtual void AddEmbeddedShellClient( 83 virtual void MergeService(std::unique_ptr<shell::Service> service) = 0;
84 std::unique_ptr<shell::ShellClient> shell_client) = 0; 84 virtual void MergeService(shell::Service* service) = 0;
85 virtual void AddEmbeddedShellClient(shell::ShellClient* shell_client) = 0;
86 85
87 // Adds an embedded service to this connection's ShellClientFactory. 86 // Adds an embedded service to this connection's ServiceFactory.
88 // |info| provides details on how to construct new instances of the 87 // |info| provides details on how to construct new instances of the
89 // service when an incoming connection is made to |name|. 88 // service when an incoming connection is made to |name|.
90 virtual void AddEmbeddedService(const std::string& name, 89 virtual void AddEmbeddedService(const std::string& name,
91 const MojoApplicationInfo& info) = 0; 90 const MojoApplicationInfo& info) = 0;
92 91
93 // Adds a generic ShellClientRequestHandler for a given service name. This 92 // Adds a generic ServiceRequestHandler for a given service name. This
94 // will be used to satisfy any incoming calls to CreateShellClient() which 93 // will be used to satisfy any incoming calls to CreateService() which
95 // reference the given name. 94 // reference the given name.
96 // 95 //
97 // For in-process services, it is preferable to use |AddEmbeddedService()| as 96 // For in-process services, it is preferable to use |AddEmbeddedService()| as
98 // defined above. 97 // defined above.
99 virtual void AddShellClientRequestHandler( 98 virtual void AddServiceRequestHandler(
100 const std::string& name, 99 const std::string& name,
101 const ShellClientRequestHandler& handler) = 0; 100 const ServiceRequestHandler& handler) = 0;
102 }; 101 };
103 102
104 } // namespace content 103 } // namespace content
105 104
106 #endif // CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_ 105 #endif // CONTENT_PUBLIC_COMMON_MOJO_SHELL_CONNECTION_H_
OLDNEW
« no previous file with comments | « content/public/common/mojo_application_info.cc ('k') | content/public/test/test_mojo_app.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698