OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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 CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ | 5 #ifndef CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ |
6 #define CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ | 6 #define CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 #include <map> | 9 #include <map> |
10 | 10 |
11 #include "base/memory/linked_ptr.h" | 11 #include "base/memory/linked_ptr.h" |
12 #include "v8/include/v8.h" | 12 #include "v8/include/v8.h" |
13 | 13 |
14 namespace base { | 14 namespace base { |
15 class ListValue; | 15 class ListValue; |
16 } | 16 } |
17 | 17 |
18 namespace extensions { | 18 namespace extensions { |
19 class ChromeV8Context; | 19 class ChromeV8Context; |
20 class Dispatcher; | 20 class Dispatcher; |
21 | 21 |
22 struct PendingRequest; | 22 struct PendingRequest; |
23 | 23 |
24 // Responsible for sending requests for named extension API functions to the | 24 // Responsible for sending requests for named extension API functions to the |
25 // extension host and routing the responses back to the caller. | 25 // extension host and routing the responses back to the caller. |
26 class RequestSender { | 26 class RequestSender { |
27 public: | 27 public: |
28 // Source represents a user of RequestSender. Every request is associated with | |
29 // a Source object, which will be notified when the corresponding response | |
30 // arrives. When a Source object is going away and there are pending requests, | |
31 // it should call InvalidateSource() to make sure no notifications are sent to | |
32 // it later. | |
33 class Source { | |
34 public: | |
35 virtual ~Source() {} | |
36 | |
37 virtual ChromeV8Context* GetContext() = 0; | |
asargent_no_longer_on_chrome
2013/03/28 20:33:26
Eventually it might be interesting to abstract thi
yzshen1
2013/03/28 22:25:22
I will bear that in mind. I think I will touch thi
| |
38 virtual void OnResponseReceived(const std::string& name, | |
39 int request_id, | |
40 bool success, | |
41 const base::ListValue& response, | |
42 const std::string& error) = 0; | |
43 }; | |
44 | |
28 explicit RequestSender(Dispatcher* dispatcher); | 45 explicit RequestSender(Dispatcher* dispatcher); |
29 ~RequestSender(); | 46 ~RequestSender(); |
30 | 47 |
48 // In order to avoid collision, all |request_id|s passed into StartRequest() | |
49 // should be generated by this method. | |
50 int GetNextRequestId() const; | |
51 | |
31 // Makes a call to the API function |name| that is to be handled by the | 52 // Makes a call to the API function |name| that is to be handled by the |
32 // extension host. The response to this request will be received in | 53 // extension host. The response to this request will be received in |
33 // HandleResponse(). | 54 // HandleResponse(). |
34 // TODO(koz): Remove |request_id| and generate that internally. | 55 // TODO(koz): Remove |request_id| and generate that internally. |
35 // There are multiple of these per render view though, so we'll | 56 // There are multiple of these per render view though, so we'll |
36 // need to vend the IDs centrally. | 57 // need to vend the IDs centrally. |
37 void StartRequest(ChromeV8Context* target_context, | 58 void StartRequest(Source* source, |
38 const std::string& name, | 59 const std::string& name, |
39 int request_id, | 60 int request_id, |
40 bool has_callback, | 61 bool has_callback, |
41 bool for_io_thread, | 62 bool for_io_thread, |
42 base::ListValue* value_args); | 63 base::ListValue* value_args); |
43 | 64 |
44 // Handles responses from the extension host to calls made by StartRequest(). | 65 // Handles responses from the extension host to calls made by StartRequest(). |
45 void HandleResponse(int request_id, | 66 void HandleResponse(int request_id, |
46 bool success, | 67 bool success, |
47 const base::ListValue& response, | 68 const base::ListValue& response, |
48 const std::string& error); | 69 const std::string& error); |
49 | 70 |
50 // Notifies this that a context is no longer valid. | 71 // Notifies this that a request source is no longer valid. |
51 // TODO(kalman): Do this in a generic/safe way. | 72 // TODO(kalman): Do this in a generic/safe way. |
52 void InvalidateContext(ChromeV8Context* context); | 73 void InvalidateSource(Source* source); |
53 | 74 |
54 private: | 75 private: |
55 typedef std::map<int, linked_ptr<PendingRequest> > PendingRequestMap; | 76 typedef std::map<int, linked_ptr<PendingRequest> > PendingRequestMap; |
56 | 77 |
57 void InsertRequest(int request_id, PendingRequest* pending_request); | 78 void InsertRequest(int request_id, PendingRequest* pending_request); |
58 linked_ptr<PendingRequest> RemoveRequest(int request_id); | 79 linked_ptr<PendingRequest> RemoveRequest(int request_id); |
59 | 80 |
60 Dispatcher* dispatcher_; | 81 Dispatcher* dispatcher_; |
61 PendingRequestMap pending_requests_; | 82 PendingRequestMap pending_requests_; |
62 | 83 |
63 DISALLOW_COPY_AND_ASSIGN(RequestSender); | 84 DISALLOW_COPY_AND_ASSIGN(RequestSender); |
64 }; | 85 }; |
65 | 86 |
66 } // namespace extensions | 87 } // namespace extensions |
67 | 88 |
68 #endif // CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ | 89 #endif // CHROME_RENDERER_EXTENSIONS_REQUEST_SENDER_H_ |
OLD | NEW |