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 COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ | 5 #ifndef COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ |
6 #define COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ | 6 #define COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 #include <vector> | 9 #include <vector> |
10 | 10 |
(...skipping 17 matching lines...) Expand all Loading... | |
28 PendingRequest(const copresence::ReportRequest& report, | 28 PendingRequest(const copresence::ReportRequest& report, |
29 const std::string app_id, | 29 const std::string app_id, |
30 const StatusCallback& callback); | 30 const StatusCallback& callback); |
31 ~PendingRequest(); | 31 ~PendingRequest(); |
32 | 32 |
33 copresence::ReportRequest report; | 33 copresence::ReportRequest report; |
34 std::string app_id; | 34 std::string app_id; |
35 StatusCallback callback; | 35 StatusCallback callback; |
36 }; | 36 }; |
37 | 37 |
38 // The CopresenceClient class is the central interface for Copresence | 38 // The CopresenceClient class is the central interface for Copresence |
blundell
2014/08/11 12:42:54
The "Client" suffix is typically used in Chromium
| |
39 // functionality. This class handles all the initialization and delegation of | 39 // functionality. This class handles all the initialization and delegation |
40 // copresence tasks. Any user of copresence only needs to interact with this | 40 // of copresence tasks. Any user of copresence only needs to interact |
41 // client. | 41 // with this client. |
42 class CopresenceClient : public base::SupportsWeakPtr<CopresenceClient> { | 42 class CopresenceClient : public base::SupportsWeakPtr<CopresenceClient> { |
43 public: | 43 public: |
44 // The delegate must outlive us. | 44 // The delegate must outlive us. |
45 explicit CopresenceClient(CopresenceClientDelegate* delegate); | 45 explicit CopresenceClient(CopresenceClientDelegate* delegate); |
46 virtual ~CopresenceClient(); | 46 virtual ~CopresenceClient(); |
47 | 47 |
48 // This method will execute a report request. Each report request can have | 48 // This method will execute a report request. Each report request can have |
49 // multiple (un)publishes, (un)subscribes. This will ensure that once the | 49 // multiple (un)publishes, (un)subscribes. This will ensure that once the |
50 // client is initialized, it sends all request to the server and handles | 50 // client is initialized, it sends all request to the server and handles |
51 // the response. If an error is encountered, the status callback is used | 51 // the response. If an error is encountered, the status callback is used |
52 // to relay it to the requester. | 52 // to relay it to the requester. |
53 void ExecuteReportRequest(copresence::ReportRequest request, | 53 void ExecuteReportRequest(copresence::ReportRequest request, |
54 const std::string& app_id, | 54 const std::string& app_id, |
55 const StatusCallback& callback); | 55 const StatusCallback& callback); |
56 | 56 |
57 // Called before the API (and thus the Client) is destructed. | |
58 void Shutdown(); | |
59 | |
60 private: | 57 private: |
61 void CompleteInitialization(); | 58 void CompleteInitialization(); |
62 void InitStepComplete(const std::string& step, bool success); | 59 void InitStepComplete(const std::string& step, bool success); |
63 | 60 |
64 CopresenceClientDelegate* delegate_; | 61 CopresenceClientDelegate* delegate_; |
65 bool init_failed_; | 62 bool init_failed_; |
66 std::vector<PendingRequest> pending_requests_queue_; | 63 std::vector<PendingRequest> pending_requests_queue_; |
67 | 64 |
68 // TODO(rkc): This code is almost identical to what we use in feedback to | 65 // TODO(rkc): This code is almost identical to what we use in feedback to |
69 // perform multiple blocking tasks and then run a post process method. Look | 66 // perform multiple blocking tasks and then run a post process method. Look |
70 // into refactoring it all out to a common construct, like maybe a | 67 // into refactoring it all out to a common construct, like maybe a |
71 // PostMultipleTasksAndReply? | 68 // PostMultipleTasksAndReply? |
72 size_t pending_init_operations_; | 69 size_t pending_init_operations_; |
73 | 70 |
74 scoped_ptr<RpcHandler> rpc_handler_; | 71 scoped_ptr<RpcHandler> rpc_handler_; |
75 | 72 |
76 DISALLOW_COPY_AND_ASSIGN(CopresenceClient); | 73 DISALLOW_COPY_AND_ASSIGN(CopresenceClient); |
77 }; | 74 }; |
78 | 75 |
79 } // namespace copresence | 76 } // namespace copresence |
80 | 77 |
81 #endif // COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ | 78 #endif // COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ |
OLD | NEW |