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 module mojo.shell.mojom; | 5 module mojo.shell.mojom; |
6 | 6 |
7 import "mojo/shell/public/interfaces/service_provider.mojom"; | 7 import "mojo/shell/public/interfaces/interface_provider.mojom"; |
8 import "mojo/shell/public/interfaces/shell.mojom"; | 8 import "mojo/shell/public/interfaces/shell.mojom"; |
9 | 9 |
10 // TODO(beng): rewrite these comments. | 10 // TODO(beng): rewrite these comments. |
11 // This is the primary interface implemented by every Mojo application. It | 11 // This is the primary interface implemented by every Mojo application. It |
12 // allows the application to receive its startup arguments from the shell, and | 12 // allows the application to receive its startup arguments from the shell, and |
13 // to be notified of events that occur during its execution. | 13 // to be notified of events that occur during its execution. |
14 // | 14 // |
15 // TODO(aa): It would be good to reorder the parameters once we have interface | 15 // TODO(aa): It would be good to reorder the parameters once we have interface |
16 // versioning. | 16 // versioning. |
17 interface ShellClient { | 17 interface ShellClient { |
(...skipping 11 matching lines...) Expand all Loading... |
29 // ApplicationManager. It can be passed to other shell interfaces that request | 29 // ApplicationManager. It can be passed to other shell interfaces that request |
30 // an instance identifier. | 30 // an instance identifier. |
31 Initialize(Shell shell, string url, uint32 id); | 31 Initialize(Shell shell, string url, uint32 id); |
32 | 32 |
33 // Called when another application (identified by |requestor_url|) attempts to | 33 // Called when another application (identified by |requestor_url|) attempts to |
34 // open a connection to this application. | 34 // open a connection to this application. |
35 // | 35 // |
36 // If the other application wants to request services from this application, | 36 // If the other application wants to request services from this application, |
37 // it will have passed a valid interface request through the |services| | 37 // it will have passed a valid interface request through the |services| |
38 // parameter (i.e. one containing a valid message pipe endpoint). This | 38 // parameter (i.e. one containing a valid message pipe endpoint). This |
39 // application may then bind an implementation of |ServiceProvider| to that | 39 // application may then bind an implementation of |InterfaceProvider| to that |
40 // request in order to make services available to the other application. | 40 // request in order to make services available to the other application. |
41 // | 41 // |
42 // If the other application wants to offer services to this application, it | 42 // If the other application wants to offer services to this application, it |
43 // will have passed a bound interface through the |exposed_services| | 43 // will have passed a bound interface through the |exposed_services| |
44 // parameter. This application may then request services through that | 44 // parameter. This application may then request services through that |
45 // interface. | 45 // interface. |
46 // | 46 // |
47 // It is possible that both parameters will be valid/bound if the other | 47 // It is possible that both parameters will be valid/bound if the other |
48 // application wants to both request services from and offer services to this | 48 // application wants to both request services from and offer services to this |
49 // application. | 49 // application. |
50 // | 50 // |
51 // This application is free to ignore the |services| or |exposed_services| | 51 // This application is free to ignore the |services| or |exposed_services| |
52 // parameters if it does not wish to offer or request services. | 52 // parameters if it does not wish to offer or request services. |
53 // | 53 // |
54 // |allowed_interfaces| is a set of interface names that the shell has | 54 // |allowed_interfaces| is a set of interface names that the shell has |
55 // determined can be exposed by this application to the connecting | 55 // determined can be exposed by this application to the connecting |
56 // application. When this parameter is empty, this application should expose | 56 // application. When this parameter is empty, this application should expose |
57 // no services to the connecting application. When this parameter contains | 57 // no services to the connecting application. When this parameter contains |
58 // only the single string value "*" the application may expose all of its | 58 // only the single string value "*" the application may expose all of its |
59 // services to the connecting application. | 59 // services to the connecting application. |
60 // | 60 // |
61 // |resolved_url| is the URL that was requested to create this connection, | 61 // |resolved_url| is the URL that was requested to create this connection, |
62 // after all mappings, resolutions, and redirects. This will include any | 62 // after all mappings, resolutions, and redirects. This will include any |
63 // querystring that was part of the request. | 63 // querystring that was part of the request. |
64 // | 64 // |
65 AcceptConnection(string requestor_url, | 65 AcceptConnection(string requestor_url, |
66 uint32 requestor_id, | 66 uint32 requestor_id, |
67 mojo.ServiceProvider&? services, | 67 mojo.InterfaceProvider&? local_interfaces, |
68 mojo.ServiceProvider? exposed_services, | 68 mojo.InterfaceProvider? remote_interfaces, |
69 array<string> allowed_interfaces, | 69 array<string> allowed_interfaces, |
70 string resolved_url); | 70 string resolved_url); |
71 | 71 |
72 // Called by the shell in response to calling Shell's QuitApplication. The | 72 // Called by the shell in response to calling Shell's QuitApplication. The |
73 // application should run the callback with true if shutdown can proceed. | 73 // application should run the callback with true if shutdown can proceed. |
74 // See Shell::QuitApplication for details about shutdown workflow. | 74 // See Shell::QuitApplication for details about shutdown workflow. |
75 OnQuitRequested() => (bool can_quit); | 75 OnQuitRequested() => (bool can_quit); |
76 }; | 76 }; |
OLD | NEW |