OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 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 SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ | 5 #ifndef SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ |
6 #define SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ | 6 #define SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ |
7 | 7 |
8 #include <memory> | 8 #include <memory> |
9 #include <utility> | 9 #include <utility> |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
12 #include "base/callback.h" | 12 #include "base/callback.h" |
13 #include "base/macros.h" | 13 #include "base/macros.h" |
14 #include "base/memory/scoped_vector.h" | 14 #include "base/memory/scoped_vector.h" |
15 #include "mojo/public/cpp/bindings/binding.h" | 15 #include "mojo/public/cpp/bindings/binding.h" |
16 #include "mojo/public/cpp/system/core.h" | 16 #include "mojo/public/cpp/system/core.h" |
17 #include "services/shell/public/cpp/shell_client.h" | 17 #include "services/shell/public/cpp/service.h" |
18 #include "services/shell/public/interfaces/connector.mojom.h" | 18 #include "services/shell/public/interfaces/connector.mojom.h" |
19 #include "services/shell/public/interfaces/shell_client.mojom.h" | 19 #include "services/shell/public/interfaces/service.mojom.h" |
20 | 20 |
21 namespace shell { | 21 namespace shell { |
22 | 22 |
23 class Connector; | 23 class Connector; |
24 | 24 |
25 // Encapsulates a connection to the Mojo Shell in two parts: | 25 // Encapsulates a connection to the Mojo Shell in two parts: |
26 // - a bound InterfacePtr to mojom::Shell, the primary mechanism | 26 // - a bound InterfacePtr to mojom::Shell, the primary mechanism |
27 // by which the instantiating application interacts with other services | 27 // by which the instantiating application interacts with other services |
28 // brokered by the Mojo Shell. | 28 // brokered by the Mojo Shell. |
29 // - a bound InterfaceRequest of mojom::ShellClient, an interface | 29 // - a bound InterfaceRequest of mojom::Service, an interface |
30 // used by the Mojo Shell to inform this application of lifecycle events and | 30 // used by the Mojo Shell to inform this application of lifecycle events and |
31 // inbound connections brokered by it. | 31 // inbound connections brokered by it. |
32 // | 32 // |
33 // This class should be used in two scenarios: | 33 // This class should be used in two scenarios: |
34 // - During early startup to bind the mojom::ShellClientRequest obtained from | 34 // - During early startup to bind the mojom::ServiceRequest obtained from |
35 // the Mojo Shell, typically in response to either MojoMain() or main(). | 35 // the Mojo Shell, typically in response to either MojoMain() or main(). |
36 // - In an implementation of mojom::ShellClientFactory to bind the | 36 // - In an implementation of mojom::ServiceFactory to bind the |
37 // mojom::ShellClientRequest passed via StartApplication. In this scenario | 37 // mojom::ServiceRequest passed via StartApplication. In this scenario |
38 // there can be many instances of this class per process. | 38 // there can be many instances of this class per process. |
39 // | 39 // |
40 // Instances of this class are constructed with an implementation of the Shell | 40 // Instances of this class are constructed with an implementation of the Shell |
41 // Client Lib's ShellClient interface. See documentation in shell_client.h | 41 // Client Lib's Service interface. See documentation in service.h |
42 // for details. | 42 // for details. |
43 // | 43 // |
44 class ShellConnection : public mojom::ShellClient { | 44 class ShellConnection : public mojom::Service { |
45 public: | 45 public: |
46 // Creates a new ShellConnection bound to |request|. This connection may be | 46 // Creates a new ShellConnection bound to |request|. This connection may be |
47 // used immediately to make outgoing connections via connector(). Does not | 47 // used immediately to make outgoing connections via connector(). Does not |
48 // take ownership of |client|, which must remain valid for the lifetime of | 48 // take ownership of |client|, which must remain valid for the lifetime of |
49 // ShellConnection. | 49 // ShellConnection. |
50 ShellConnection(shell::ShellClient* client, | 50 ShellConnection(shell::Service* client, |
51 mojom::ShellClientRequest request); | 51 mojom::ServiceRequest request); |
52 | 52 |
53 ~ShellConnection() override; | 53 ~ShellConnection() override; |
54 | 54 |
55 Connector* connector() { return connector_.get(); } | 55 Connector* connector() { return connector_.get(); } |
56 const Identity& identity() { return identity_; } | 56 const Identity& identity() { return identity_; } |
57 | 57 |
58 // TODO(rockot): Remove this. http://crbug.com/594852. | 58 // TODO(rockot): Remove this. http://crbug.com/594852. |
59 void set_initialize_handler(const base::Closure& callback); | 59 void set_initialize_handler(const base::Closure& callback); |
60 | 60 |
61 // TODO(rockot): Remove this once we get rid of app tests. | 61 // TODO(rockot): Remove this once we get rid of app tests. |
62 void SetAppTestConnectorForTesting(mojom::ConnectorPtr connector); | 62 void SetAppTestConnectorForTesting(mojom::ConnectorPtr connector); |
63 | 63 |
64 // Specify a function to be called when the connection to the shell is lost. | 64 // Specify a function to be called when the connection to the shell is lost. |
65 // Note that if connection has already been lost, then |closure| is called | 65 // Note that if connection has already been lost, then |closure| is called |
66 // immediately. | 66 // immediately. |
67 void SetConnectionLostClosure(const base::Closure& closure); | 67 void SetConnectionLostClosure(const base::Closure& closure); |
68 | 68 |
69 private: | 69 private: |
70 // mojom::ShellClient: | 70 // mojom::Service: |
71 void Initialize(mojom::IdentityPtr identity, | 71 void OnStart(mojom::IdentityPtr identity, |
72 uint32_t id, | 72 uint32_t id, |
73 const InitializeCallback& callback) override; | 73 const OnStartCallback& callback) override; |
74 void AcceptConnection(mojom::IdentityPtr source, | 74 void OnConnect(mojom::IdentityPtr source, |
75 uint32_t source_id, | 75 uint32_t source_id, |
76 mojom::InterfaceProviderRequest remote_interfaces, | 76 mojom::InterfaceProviderRequest remote_interfaces, |
77 mojom::InterfaceProviderPtr local_interfaces, | 77 mojom::InterfaceProviderPtr local_interfaces, |
78 mojom::CapabilityRequestPtr allowed_capabilities, | 78 mojom::CapabilityRequestPtr allowed_capabilities, |
79 const mojo::String& name) override; | 79 const mojo::String& name) override; |
80 | 80 |
81 void OnConnectionError(); | 81 void OnConnectionError(); |
82 | 82 |
83 // A callback called when Initialize() is run. | 83 // A callback called when OnStart() is run. |
84 base::Closure initialize_handler_; | 84 base::Closure initialize_handler_; |
85 | 85 |
86 // We track the lifetime of incoming connection registries as it more | 86 // We track the lifetime of incoming connection registries as it more |
87 // convenient for the client. | 87 // convenient for the client. |
88 ScopedVector<Connection> incoming_connections_; | 88 ScopedVector<Connection> incoming_connections_; |
89 | 89 |
90 // A pending Connector request which will eventually be passed to the shell. | 90 // A pending Connector request which will eventually be passed to the shell. |
91 mojom::ConnectorRequest pending_connector_request_; | 91 mojom::ConnectorRequest pending_connector_request_; |
92 | 92 |
93 shell::ShellClient* client_; | 93 shell::Service* client_; |
94 mojo::Binding<mojom::ShellClient> binding_; | 94 mojo::Binding<mojom::Service> binding_; |
95 std::unique_ptr<Connector> connector_; | 95 std::unique_ptr<Connector> connector_; |
96 shell::Identity identity_; | 96 shell::Identity identity_; |
97 bool should_run_connection_lost_closure_ = false; | 97 bool should_run_connection_lost_closure_ = false; |
98 | 98 |
99 base::Closure connection_lost_closure_; | 99 base::Closure connection_lost_closure_; |
100 | 100 |
101 DISALLOW_COPY_AND_ASSIGN(ShellConnection); | 101 DISALLOW_COPY_AND_ASSIGN(ShellConnection); |
102 }; | 102 }; |
103 | 103 |
104 } // namespace shell | 104 } // namespace shell |
105 | 105 |
106 #endif // SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ | 106 #endif // SERVICES_SHELL_PUBLIC_CPP_SHELL_CONNECTION_H_ |
OLD | NEW |