blob: c3b8538944cab24ed49a9ecbda9e097ba0659b17 [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <map>
#include <string>
#include "base/memory/linked_ptr.h"
#include "v8/include/v8.h"
namespace base {
class ListValue;
namespace extensions {
class Dispatcher;
class ScriptContext;
struct PendingRequest;
// Responsible for sending requests for named extension API functions to the
// extension host and routing the responses back to the caller.
class RequestSender {
// Source represents a user of RequestSender. Every request is associated with
// a Source object, which will be notified when the corresponding response
// arrives. When a Source object is going away and there are pending requests,
// it should call InvalidateSource() to make sure no notifications are sent to
// it later.
class Source {
virtual ~Source() {}
virtual ScriptContext* GetContext() = 0;
virtual void OnResponseReceived(const std::string& name,
int request_id,
bool success,
const base::ListValue& response,
const std::string& error) = 0;
// Helper class to (re)set the |source_tab_id_| below.
class ScopedTabID {
ScopedTabID(RequestSender* request_sender, int tab_id);
RequestSender* const request_sender_;
const int tab_id_;
const int previous_tab_id_;
explicit RequestSender(Dispatcher* dispatcher);
// In order to avoid collision, all |request_id|s passed into StartRequest()
// should be generated by this method.
int GetNextRequestId() const;
// Makes a call to the API function |name| that is to be handled by the
// extension host. The response to this request will be received in
// HandleResponse().
// TODO(koz): Remove |request_id| and generate that internally.
// There are multiple of these per render view though, so we'll
// need to vend the IDs centrally.
void StartRequest(Source* source,
const std::string& name,
int request_id,
bool has_callback,
bool for_io_thread,
base::ListValue* value_args);
// Handles responses from the extension host to calls made by StartRequest().
void HandleResponse(int request_id,
bool success,
const base::ListValue& response,
const std::string& error);
// Notifies this that a request source is no longer valid.
// TODO(kalman): Do this in a generic/safe way.
void InvalidateSource(Source* source);
friend class ScopedTabID;
typedef std::map<int, linked_ptr<PendingRequest> > PendingRequestMap;
void InsertRequest(int request_id, PendingRequest* pending_request);
linked_ptr<PendingRequest> RemoveRequest(int request_id);
Dispatcher* dispatcher_;
PendingRequestMap pending_requests_;
int source_tab_id_; // Id of the tab sending the request, or -1 if no tab.
} // namespace extensions