OLD | NEW |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 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 // This is a client library that constructs a MojoLogger that can talk to a | 5 // This is a client library that constructs a MojoLogger that can talk to a |
6 // Mojo logging service (see ../interfaces/log.mojo). It provides a |MojoLogger| | 6 // Mojo logging service (see ../interfaces/log.mojo). It provides a |MojoLogger| |
7 // implementation which can be used as the default environment logger. | 7 // implementation which can be used as the default environment logger. |
8 // | 8 // |
9 // Example application that uses this log client to talk to the log service: | 9 // Example application that uses this log client to talk to the log service: |
10 // | 10 // |
11 // class MyApp : public mojo::ApplicationImplBase { | 11 // class MyApp : public mojo::ApplicationImplBase { |
12 // public: | 12 // public: |
13 // void OnInitialize() override { | 13 // void OnInitialize() override { |
14 // LogPtr log; | 14 // LogPtr log; |
15 // mojo::ConnectToService(shell(), "mojo:log", &log); | 15 // mojo::ConnectToService(shell(), "mojo:log", &log); |
16 // mojo::log::InitializeLogger(std::move(log), | 16 // mojo::log::InitializeLogger(std::move(log), |
17 // mojo::Environment::GetDefaultLogger()); | 17 // mojo::Environment::GetDefaultLogger()); |
18 // mojo::Environment::SetDefaultLogger(mojo::log::GetLogger()); | 18 // mojo::Environment::SetDefaultLogger(mojo::log::GetLogger()); |
19 // } | 19 // } |
20 // | 20 // |
21 // void OnQuit() override { | 21 // void OnQuit() override { |
22 // mojo::log::DestroyLogger(); | 22 // mojo::log::DestroyLogger(); |
23 // } | 23 // } |
24 // }; | 24 // }; |
25 // | 25 // |
26 // MojoResult MojoMain(MojoHandle app_request) { | 26 // MojoResult MojoMain(MojoHandle app_request) { |
27 // MyApp app; | 27 // MyApp app; |
28 // return mojo::RunMainApplication(&app); | 28 // return mojo::RunApplication(&app); |
29 // } | 29 // } |
30 | 30 |
31 #ifndef MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ | 31 #ifndef MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ |
32 #define MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ | 32 #define MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ |
33 | 33 |
34 #include "mojo/public/c/environment/logger.h" | 34 #include "mojo/public/c/environment/logger.h" |
35 #include "mojo/services/log/interfaces/log.mojom.h" | 35 #include "mojo/services/log/interfaces/log.mojom.h" |
36 | 36 |
37 namespace mojo { | 37 namespace mojo { |
38 namespace log { | 38 namespace log { |
39 | 39 |
40 // Constructs a MojoLogger (which can be retrieved with |GetLogger()|) that | 40 // Constructs a MojoLogger (which can be retrieved with |GetLogger()|) that |
41 // talks to the provided log service. |fallback_logger| must be non-null and | 41 // talks to the provided log service. |fallback_logger| must be non-null and |
42 // will be used if the provided |log_service| fails. The constructed MojoLogger | 42 // will be used if the provided |log_service| fails. The constructed MojoLogger |
43 // may also call into |fallback_logger|'s [Set|Get]MinimumLogLevel functions to | 43 // may also call into |fallback_logger|'s [Set|Get]MinimumLogLevel functions to |
44 // keep the minimum levels consistent. | 44 // keep the minimum levels consistent. |
45 void InitializeLogger(LogPtr log_service, const MojoLogger* fallback_logger); | 45 void InitializeLogger(LogPtr log_service, const MojoLogger* fallback_logger); |
46 | 46 |
47 // Must be called after |InitializeLogger()| and before |DestroyLogger()|. The | 47 // Must be called after |InitializeLogger()| and before |DestroyLogger()|. The |
48 // returned MojoLogger is thread-safe. | 48 // returned MojoLogger is thread-safe. |
49 const MojoLogger* GetLogger(); | 49 const MojoLogger* GetLogger(); |
50 | 50 |
51 void DestroyLogger(); | 51 void DestroyLogger(); |
52 | 52 |
53 } // namespace log | 53 } // namespace log |
54 } // namespace mojo | 54 } // namespace mojo |
55 | 55 |
56 #endif // MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ | 56 #endif // MOJO_SERVICES_LOG_CPP_LOG_CLIENT_H_ |
OLD | NEW |