Per-renderer WebSocket throttling

content/browser/renderer_host/websocket_host.h

 // Copyright 2013 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_WEBSOCKET_HOST_H_
 #define CONTENT_BROWSER_RENDERER_HOST_WEBSOCKET_HOST_H_
 
 #include <string>
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
 #include "content/common/content_export.h"
 #include "content/common/websocket.h"
 
 class GURL;
 
 namespace url {
 class Origin;
 }  // namespace url
 
 namespace net {
 class WebSocketChannel;
 class URLRequestContext;
 }  // namespace net
 
 namespace IPC {
 class Message;
 }  // namespace IPC
 
 namespace content {
 
 class WebSocketDispatcherHost;
 
 // Host of net::WebSocketChannel. The lifetime of an instance of this class is
 // completely controlled by the WebSocketDispatcherHost object.
 class CONTENT_EXPORT WebSocketHost {
  public:
   WebSocketHost(int routing_id,
                 WebSocketDispatcherHost* dispatcher,
-                net::URLRequestContext* url_request_context);
+                net::URLRequestContext* url_request_context,
+                int delay_in_ms);

[Adam Rice, 2015/03/03 15:10:03]

I would make this argument type a base::TimeDelta so that it is not necessary to
specify the units, and to make it even more obvious what it is.

[hiroshige, 2015/03/04 06:02:38]

Done.

   virtual ~WebSocketHost();
 
   // The renderer process is going away.
   // This function is virtual for testing.
   virtual void GoAway();
 
   // General message dispatch. WebSocketDispatcherHost::OnMessageReceived
   // delegates to this method after looking up the |routing_id|.
   virtual bool OnMessageReceived(const IPC::Message& message);
 
   int routing_id() const { return routing_id_; }
 
+  bool handshakeSucceeded() const { return handshake_succeeded_; }

[Adam Rice, 2015/03/03 15:10:03]

This should be named handshake_succeeded() by Chromium style.

[hiroshige, 2015/03/04 06:02:38]

Done.

+  void OnHandshakeSucceeded() { handshake_succeeded_ = true; }
+
  private:
   // Handlers for each message type, dispatched by OnMessageReceived(), as
   // defined in content/common/websocket_messages.h
 
   void OnAddChannelRequest(const GURL& socket_url,
                            const std::vector<std::string>& requested_protocols,
                            const url::Origin& origin,
                            int render_frame_id);
 
+  void AddChannel(const GURL& socket_url,
+                  const std::vector<std::string>& requested_protocols,
+                  const url::Origin& origin,
+                  int render_frame_id);
+
   void OnSendFrame(bool fin,
                    WebSocketMessageType type,
                    const std::vector<char>& data);
 
   void OnFlowControl(int64 quota);
 
   void OnDropChannel(bool was_clean, uint16 code, const std::string& reason);
 
   // The channel we use to send events to the network.
   scoped_ptr<net::WebSocketChannel> channel_;
 
   // The WebSocketHostDispatcher that created this object.
   WebSocketDispatcherHost* const dispatcher_;
 
   // The URL request context for the channel.
   net::URLRequestContext* const url_request_context_;
 
   // The ID used to route messages.
   const int routing_id_;
 
+  // Delay used for per-renderer WebSocket throttling.
+  int delay_in_ms_;
+
+  // SendFlowControl() is delayed when OnFlowControl() is called before
+  // AddChannel() is called.
+  // A negative value indicates there is no pending SendFlowControl().

[Adam Rice, 2015/03/03 15:10:03]

I would just use 0 to mean no pending flow control. SendFlowControl(0) does
nothing so there would be no point in calling it.

[hiroshige, 2015/03/04 06:02:38]

Done.

+  int64 pending_flow_control_quota_;
+
+  // handshake_succeeded_ is set and used by WebSocketDispatcherHost
+  // to manage counters for per-renderer WebSocket throttling.
+  bool handshake_succeeded_;
+
+  base::WeakPtrFactory<WebSocketHost> weak_ptr_factory_;
+
   DISALLOW_COPY_AND_ASSIGN(WebSocketHost);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_WEBSOCKET_HOST_H_