OLD | NEW |
| (Empty) |
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 | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef MOJO_SHELL_PUBLIC_CPP_SHELL_CLIENT_H_ | |
6 #define MOJO_SHELL_PUBLIC_CPP_SHELL_CLIENT_H_ | |
7 | |
8 #include <stdint.h> | |
9 #include <string> | |
10 | |
11 #include "base/macros.h" | |
12 #include "mojo/shell/public/cpp/connection.h" | |
13 #include "mojo/shell/public/cpp/identity.h" | |
14 | |
15 namespace mojo { | |
16 | |
17 class Connector; | |
18 | |
19 // An interface representing an instance "known to the Mojo Shell". The | |
20 // implementation receives lifecycle messages for the instance and gets the | |
21 // opportunity to handle inbound connections brokered by the Shell. Every client | |
22 // of ShellConnection must implement this interface, and instances of this | |
23 // interface must outlive the ShellConnection. | |
24 class ShellClient { | |
25 public: | |
26 ShellClient(); | |
27 virtual ~ShellClient(); | |
28 | |
29 // Called once a bidirectional connection with the shell has been established. | |
30 // |identity| is the identity of the instance. | |
31 // |id| is a unique identifier the shell uses to identify this specific | |
32 // instance of the application. | |
33 // Called exactly once before any other method. | |
34 virtual void Initialize(Connector* connector, | |
35 const Identity& identity, | |
36 uint32_t id); | |
37 | |
38 // Called when a connection to this client is brokered by the shell. Override | |
39 // to expose services to the remote application. Return true if the connection | |
40 // should succeed. Return false if the connection should be rejected and the | |
41 // underlying pipe closed. The default implementation returns false. | |
42 virtual bool AcceptConnection(Connection* connection); | |
43 | |
44 // Called when ShellConnection's ShellClient binding (i.e. the pipe the | |
45 // Mojo Shell has to talk to us over) is closed. A shell client may use this | |
46 // as a signal to terminate. Return true from this method to tell the | |
47 // ShellConnection to run its connection lost closure if it has one, false to | |
48 // prevent it from being run. The default implementation returns true. | |
49 // When used in conjunction with ApplicationRunner, returning true here quits | |
50 // the message loop created by ApplicationRunner, which results in the app | |
51 // quitting. | |
52 virtual bool ShellConnectionLost(); | |
53 | |
54 private: | |
55 DISALLOW_COPY_AND_ASSIGN(ShellClient); | |
56 }; | |
57 | |
58 } // namespace mojo | |
59 | |
60 #endif // MOJO_SHELL_PUBLIC_CPP_SHELL_CLIENT_H_ | |
OLD | NEW |