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 |
11 #include "base/callback.h" | 11 #include "base/callback.h" |
12 #include "base/macros.h" | 12 #include "base/macros.h" |
13 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
14 #include "base/memory/weak_ptr.h" | |
15 #include "components/copresence/proto/rpcs.pb.h" | 14 #include "components/copresence/proto/rpcs.pb.h" |
16 #include "components/copresence/public/copresence_client_delegate.h" | 15 #include "components/copresence/public/copresence_client_delegate.h" |
17 | 16 |
18 namespace net { | 17 namespace net { |
19 class URLContextGetter; | 18 class URLContextGetter; |
20 } | 19 } |
21 | 20 |
22 namespace copresence { | 21 namespace copresence { |
23 | 22 |
24 class CopresenceClientDelegate; | 23 class CopresenceClientDelegate; |
25 class RpcHandler; | 24 class RpcHandler; |
26 | 25 |
27 struct PendingRequest { | 26 struct PendingRequest { |
28 PendingRequest(const copresence::ReportRequest& report, | 27 PendingRequest(const copresence::ReportRequest& report, |
29 const std::string app_id, | 28 const std::string app_id, |
30 const StatusCallback& callback); | 29 const StatusCallback& callback); |
31 ~PendingRequest(); | 30 ~PendingRequest(); |
32 | 31 |
33 copresence::ReportRequest report; | 32 copresence::ReportRequest report; |
34 std::string app_id; | 33 std::string app_id; |
35 StatusCallback callback; | 34 StatusCallback callback; |
36 }; | 35 }; |
37 | 36 |
38 // The CopresenceClient class is the central interface for Copresence | 37 // The CopresenceClient class is the central interface for Copresence |
39 // functionality. This class handles all the initialization and delegation of | 38 // functionality. This class handles all the initialization and delegation of |
40 // copresence tasks. Any user of copresence only needs to interact with this | 39 // copresence tasks. Any user of copresence only needs to interact with this |
41 // client. | 40 // client. |
42 class CopresenceClient : public base::SupportsWeakPtr<CopresenceClient> { | 41 class CopresenceClient { |
43 public: | 42 public: |
44 // The delegate must outlive us. | 43 // The delegate must outlive us. |
45 explicit CopresenceClient(CopresenceClientDelegate* delegate); | 44 explicit CopresenceClient(CopresenceClientDelegate* delegate); |
46 virtual ~CopresenceClient(); | 45 virtual ~CopresenceClient(); |
willchan no longer on Chromium
2014/08/08 01:05:59
Why is this virtual?
Charlie
2014/08/08 21:57:52
Oudated? WeakPtr is back.
| |
47 | 46 |
48 // This method will execute a report request. Each report request can have | 47 // This method will execute a report request. Each report request can have |
49 // multiple (un)publishes, (un)subscribes. This will ensure that once the | 48 // multiple (un)publishes, (un)subscribes. This will ensure that once the |
50 // client is initialized, it sends all request to the server and handles | 49 // 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 | 50 // the response. If an error is encountered, the status callback is used |
52 // to relay it to the requester. | 51 // to relay it to the requester. |
53 void ExecuteReportRequest(copresence::ReportRequest request, | 52 void ExecuteReportRequest(copresence::ReportRequest request, |
54 const std::string& app_id, | 53 const std::string& app_id, |
55 const StatusCallback& callback); | 54 const StatusCallback& callback); |
56 | 55 |
57 // Called before the API (and thus the Client) is destructed. | |
58 void Shutdown(); | |
59 | |
60 private: | 56 private: |
61 void CompleteInitialization(); | 57 void CompleteInitialization(); |
62 void InitStepComplete(const std::string& step, bool success); | 58 void InitStepComplete(const std::string& step, bool success); |
63 | 59 |
64 CopresenceClientDelegate* delegate_; | 60 CopresenceClientDelegate* delegate_; |
65 bool init_failed_; | 61 bool init_failed_; |
66 std::vector<PendingRequest> pending_requests_queue_; | 62 std::vector<PendingRequest> pending_requests_queue_; |
67 | 63 |
68 // TODO(rkc): This code is almost identical to what we use in feedback to | 64 // 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 | 65 // 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 | 66 // into refactoring it all out to a common construct, like maybe a |
71 // PostMultipleTasksAndReply? | 67 // PostMultipleTasksAndReply? |
72 size_t pending_init_operations_; | 68 size_t pending_init_operations_; |
73 | 69 |
74 scoped_ptr<RpcHandler> rpc_handler_; | 70 scoped_ptr<RpcHandler> rpc_handler_; |
75 | 71 |
76 DISALLOW_COPY_AND_ASSIGN(CopresenceClient); | 72 DISALLOW_COPY_AND_ASSIGN(CopresenceClient); |
77 }; | 73 }; |
78 | 74 |
79 } // namespace copresence | 75 } // namespace copresence |
80 | 76 |
81 #endif // COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ | 77 #endif // COMPONENTS_COPRESENCE_PUBLIC_COPRESENCE_CLIENT_H_ |
OLD | NEW |