Replace StreamListenSocket with StreamSocket in HttpServer.

content/browser/devtools/devtools_http_handler_impl.cc

 // Copyright (c) 2012 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 "content/browser/devtools/devtools_http_handler_impl.h"
 
 #include <algorithm>
 #include <utility>
 
 #include "base/bind.h"
@@ skipping 21 matching lines @@
 #include "content/public/common/content_client.h"
 #include "content/public/common/url_constants.h"
 #include "content/public/common/user_agent.h"
 #include "content/public/common/user_agent.h"
 #include "grit/devtools_resources_map.h"
 #include "net/base/escape.h"
 #include "net/base/io_buffer.h"
 #include "net/base/ip_endpoint.h"
 #include "net/server/http_server_request_info.h"
 #include "net/server/http_server_response_info.h"
+#include "net/socket/server_socket.h"
 
 #if defined(OS_ANDROID)
 #include "base/android/build_info.h"
 #endif
 
 namespace content {
 
 namespace {
 
 const char kDevToolsHandlerThreadName[] = "Chrome_DevToolsHandlerThread";
 
 const char kThumbUrlPrefix[] = "/thumb/";
 const char kPageUrlPrefix[] = "/devtools/page/";
 
 const char kTargetIdField[] = "id";
 const char kTargetTypeField[] = "type";
 const char kTargetTitleField[] = "title";
 const char kTargetDescriptionField[] = "description";
 const char kTargetUrlField[] = "url";
 const char kTargetThumbnailUrlField[] = "thumbnailUrl";
 const char kTargetFaviconUrlField[] = "faviconUrl";
 const char kTargetWebSocketDebuggerUrlField[] = "webSocketDebuggerUrl";
 const char kTargetDevtoolsFrontendUrlField[] = "devtoolsFrontendUrl";
 
 // An internal implementation of DevToolsClientHost that delegates
 // messages sent for DevToolsClient to a DebuggerShell instance.
 class DevToolsClientHostImpl : public DevToolsClientHost {
  public:
   DevToolsClientHostImpl(base::MessageLoop* message_loop,
-                         net::HttpServer* server,
+                         base::WeakPtr<net::HttpServer> server,
                          int connection_id)
       : message_loop_(message_loop),
         server_(server),
         connection_id_(connection_id),
         is_closed_(false),
         detach_reason_("target_closed") {}
 
   virtual ~DevToolsClientHostImpl() {}
 
   // DevToolsClientHost interface
@@ skipping 28 matching lines @@
                    connection_id_,
                    data));
   }
 
   virtual void ReplacedWithAnotherClient() OVERRIDE {
     detach_reason_ = "replaced_with_devtools";
   }
 
  private:
   base::MessageLoop* message_loop_;
-  net::HttpServer* server_;
+  base::WeakPtr<net::HttpServer> server_;

[pfeldman, 2014/05/22 06:01:05]

It was not refcounting it, so you should be fine with leaving it as raw.

[byungchul, 2014/05/28 01:19:35]

It is used in base::Bind() not to call when server is gone. Need to be weak_ptr
here.

[Ryan Sleevi, 2014/05/28 01:36:26]

Are you sure it's necessary? We may be able to get away with a
base::Unretained(this), which is possible when the callback-inducing class has
reasonable guarantees (which we've tried to do in net/, which is that we don't
PostTask deferrals but instead invoke the callbacks during processing, which has
the side-effect of guaranteeing that no callbacks are invoked once the owning
object deletes it)

[byungchul, 2014/05/30 00:19:02]

It's challenging to make HttpServer callback-driven, especially for reading. So,
let's keep current model for a while.
then, yes, weak_ptr is necessary. devtools is running on a separate thread, and
not guaranteed its existence. I think that's the reason why http server was
ref-counted object before. But, it doesn't have to be ref-counted because it is
dereferenced only on the devtools thread.

   int connection_id_;
   bool is_closed_;
   std::string detach_reason_;
 };
 
 static bool TimeComparator(const DevToolsTarget* target1,
                            const DevToolsTarget* target2) {
   return target1->GetLastActivityTime() > target2->GetLastActivityTime();
 }
 
 }  // namespace
 
 // static
 bool DevToolsHttpHandler::IsSupportedProtocolVersion(
     const std::string& version) {
   return devtools::IsSupportedProtocolVersion(version);
 }
 
 // static
 int DevToolsHttpHandler::GetFrontendResourceId(const std::string& name) {
   for (size_t i = 0; i < kDevtoolsResourcesSize; ++i) {
     if (name == kDevtoolsResources[i].name)
       return kDevtoolsResources[i].value;
   }
   return -1;
 }
 
 // static
 DevToolsHttpHandler* DevToolsHttpHandler::Start(
-    const net::StreamListenSocketFactory* socket_factory,
+    scoped_ptr<net::ServerSocket> server_socket,
     const std::string& frontend_url,
     DevToolsHttpHandlerDelegate* delegate) {
   DevToolsHttpHandlerImpl* http_handler =
-      new DevToolsHttpHandlerImpl(socket_factory,
+      new DevToolsHttpHandlerImpl(server_socket.Pass(),
                                   frontend_url,
                                   delegate);
   http_handler->Start();
   return http_handler;
 }
 
 DevToolsHttpHandlerImpl::~DevToolsHttpHandlerImpl() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   // Stop() must be called prior to destruction.
   DCHECK(server_.get() == NULL);
@@ skipping 152 matching lines @@
 void DevToolsHttpHandlerImpl::OnWebSocketRequest(
     int connection_id,
     const net::HttpServerRequestInfo& request) {
   std::string browser_prefix = "/devtools/browser";
   size_t browser_pos = request.path.find(browser_prefix);
   if (browser_pos == 0) {
     if (browser_target_) {
       server_->Send500(connection_id, "Another client already attached");
       return;
     }
-    browser_target_ = new DevToolsBrowserTarget(server_.get(), connection_id);
+    browser_target_ = new DevToolsBrowserTarget(server_->AsWeakPtr(),
+                                                connection_id);
     browser_target_->RegisterDomainHandler(
         devtools::Tracing::kName,
         new DevToolsTracingHandler(DevToolsTracingHandler::Browser),
         true /* handle on UI thread */);
     browser_target_->RegisterDomainHandler(
         TetheringHandler::kDomain,
         new TetheringHandler(delegate_.get()),
         false /* handle on this thread */);
     browser_target_->RegisterDomainHandler(
         devtools::SystemInfo::kName,
@@ skipping 260 matching lines @@
     return;
   }
 
   if (agent->IsAttached()) {
     Send500(connection_id,
             "Target with given id is being inspected: " + page_id);
     return;
   }
 
   DevToolsClientHostImpl* client_host = new DevToolsClientHostImpl(
-      thread_->message_loop(), server_.get(), connection_id);
+      thread_->message_loop(), server_->AsWeakPtr(), connection_id);
   connection_to_client_host_ui_[connection_id] = client_host;
 
   DevToolsManager::GetInstance()->
       RegisterDevToolsClientHostFor(agent, client_host);
 
   AcceptWebSocket(connection_id, request);
 }
 
 void DevToolsHttpHandlerImpl::OnWebSocketMessageUI(
     int connection_id,
@@ skipping 13 matching lines @@
   if (it != connection_to_client_host_ui_.end()) {
     DevToolsClientHostImpl* client_host =
         static_cast<DevToolsClientHostImpl*>(it->second);
     DevToolsManager::GetInstance()->ClientHostClosing(client_host);
     delete client_host;
     connection_to_client_host_ui_.erase(connection_id);
   }
 }
 
 DevToolsHttpHandlerImpl::DevToolsHttpHandlerImpl(
-    const net::StreamListenSocketFactory* socket_factory,
+    scoped_ptr<net::ServerSocket> server_socket,
     const std::string& frontend_url,
     DevToolsHttpHandlerDelegate* delegate)
     : frontend_url_(frontend_url),
-      socket_factory_(socket_factory),
+      server_socket_(server_socket.Pass()),
       delegate_(delegate) {
   if (frontend_url_.empty())
       frontend_url_ = "/devtools/devtools.html";
 
   // Balanced in ResetHandlerThreadAndRelease().
   AddRef();
 }
 
 // Runs on the handler thread
 void DevToolsHttpHandlerImpl::Init() {
-  server_ = new net::HttpServer(*socket_factory_.get(), this);
+  server_.reset(new net::HttpServer(server_socket_.Pass(), this));
 }
 
 // Runs on the handler thread
 void DevToolsHttpHandlerImpl::Teardown() {
-  server_ = NULL;
+  server_.reset(NULL);
 }
 
 // Runs on FILE thread to make sure that it is serialized against
 // {Start|Stop}HandlerThread and to allow calling pthread_join.
 void DevToolsHttpHandlerImpl::StopHandlerThread() {
   if (!thread_->message_loop())
     return;
   thread_->message_loop()->PostTask(
       FROM_HERE,
       base::Bind(&DevToolsHttpHandlerImpl::Teardown, this));
@@ skipping 18 matching lines @@
   std::string json_message;
   scoped_ptr<base::Value> message_object(new base::StringValue(message));
   base::JSONWriter::Write(message_object.get(), &json_message);
 
   net::HttpServerResponseInfo response(status_code);
   response.SetBody(json_value + message, "application/json; charset=UTF-8");
 
   thread_->message_loop()->PostTask(
       FROM_HERE,
       base::Bind(&net::HttpServer::SendResponse,
-                 server_.get(),
+                 server_->AsWeakPtr(),
                  connection_id,
                  response));
 }
 
 void DevToolsHttpHandlerImpl::Send200(int connection_id,
                                       const std::string& data,
                                       const std::string& mime_type) {
   if (!thread_)
     return;
   thread_->message_loop()->PostTask(
       FROM_HERE,
       base::Bind(&net::HttpServer::Send200,
-                 server_.get(),
+                 server_->AsWeakPtr(),
                  connection_id,
                  data,
                  mime_type));
 }
 
 void DevToolsHttpHandlerImpl::Send404(int connection_id) {
   if (!thread_)
     return;
   thread_->message_loop()->PostTask(
       FROM_HERE,
-      base::Bind(&net::HttpServer::Send404, server_.get(), connection_id));
+      base::Bind(&net::HttpServer::Send404,
+                 server_->AsWeakPtr(),
+                 connection_id));
 }
 
 void DevToolsHttpHandlerImpl::Send500(int connection_id,
                                       const std::string& message) {
   if (!thread_)
     return;
   thread_->message_loop()->PostTask(
       FROM_HERE,
-      base::Bind(&net::HttpServer::Send500, server_.get(), connection_id,
+      base::Bind(&net::HttpServer::Send500,
+                 server_->AsWeakPtr(),
+                 connection_id,
                  message));
 }
 
 void DevToolsHttpHandlerImpl::AcceptWebSocket(
     int connection_id,
     const net::HttpServerRequestInfo& request) {
   if (!thread_)
     return;
   thread_->message_loop()->PostTask(
       FROM_HERE,
-      base::Bind(&net::HttpServer::AcceptWebSocket, server_.get(),
-                 connection_id, request));
+      base::Bind(&net::HttpServer::AcceptWebSocket,
+                 server_->AsWeakPtr(),
+                 connection_id,
+                 request));
 }
 
 base::DictionaryValue* DevToolsHttpHandlerImpl::SerializeTarget(
     const DevToolsTarget& target,
     const std::string& host) {
   base::DictionaryValue* dictionary = new base::DictionaryValue;
 
   std::string id = target.GetId();
   dictionary->SetString(kTargetIdField, id);
   dictionary->SetString(kTargetTypeField, target.GetType());
@@ skipping 23 matching lines @@
         id.c_str(),
         host);
     dictionary->SetString(
         kTargetDevtoolsFrontendUrlField, devtools_frontend_url);
   }
 
   return dictionary;
 }
 
 }  // namespace content