Implement throttling behavior for LocalStorage mojo messages.

mojo/public/cpp/bindings/lib/multiplex_router.h

 // Copyright 2015 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 MOJO_PUBLIC_CPP_BINDINGS_LIB_MULTIPLEX_ROUTER_H_
 #define MOJO_PUBLIC_CPP_BINDINGS_LIB_MULTIPLEX_ROUTER_H_
 
 #include <stdint.h>
 
 #include <deque>
@@ skipping 52 matching lines @@
     // interfaces. In that case, this router may still receive pipe control
     // messages or messages targetting associated interfaces.
     SINGLE_INTERFACE,
     // Similar to the mode above, there is only the master interface running on
     // this router. Besides, the master interface has sync methods.
     SINGLE_INTERFACE_WITH_SYNC_METHODS,
     // There may be associated interfaces running on this router.
     MULTI_INTERFACE
   };
 
+  // Specifies whether we are allowed to directly call into
+  // InterfaceEndpointClient (given that we are already on the same thread as
+  // the client).
+  enum ClientCallBehavior {
+    // Don't call any InterfaceEndpointClient methods directly.
+    NO_DIRECT_CLIENT_CALLS,
+    // Only call InterfaceEndpointClient::HandleIncomingMessage directly to
+    // handle sync messages.
+    ALLOW_DIRECT_CLIENT_CALLS_FOR_SYNC_MESSAGES,
+    // Allow to call any InterfaceEndpointClient methods directly.
+    ALLOW_DIRECT_CLIENT_CALLS
+  };
+
   // If |set_interface_id_namespace_bit| is true, the interface IDs generated by
   // this router will have the highest bit set.
   MultiplexRouter(ScopedMessagePipeHandle message_pipe,
                   Config config,
                   bool set_interface_id_namespace_bit,
-                  scoped_refptr<base::SingleThreadTaskRunner> runner);
+                  scoped_refptr<base::SingleThreadTaskRunner> runner,
+                  ClientCallBehavior sync_client_call_behavior =
+                      ALLOW_DIRECT_CLIENT_CALLS_FOR_SYNC_MESSAGES);
 
   // Sets the master interface name for this router. Only used when reporting
   // message header or control message validation errors.
   void SetMasterInterfaceName(const std::string& name);
 
   // ---------------------------------------------------------------------------
   // The following public methods are safe to call from any threads.
 
   // AssociatedGroupController implementation:
   void CreateEndpointHandlePair(
@@ skipping 67 matching lines @@
 
   // MessageReceiver implementation:
   bool Accept(Message* message) override;
 
   // PipeControlMessageHandlerDelegate implementation:
   bool OnPeerAssociatedEndpointClosed(InterfaceId id) override;
   bool OnAssociatedEndpointClosedBeforeSent(InterfaceId id) override;
 
   void OnPipeConnectionError();
 
-  // Specifies whether we are allowed to directly call into
-  // InterfaceEndpointClient (given that we are already on the same thread as
-  // the client).
-  enum ClientCallBehavior {
-    // Don't call any InterfaceEndpointClient methods directly.
-    NO_DIRECT_CLIENT_CALLS,
-    // Only call InterfaceEndpointClient::HandleIncomingMessage directly to
-    // handle sync messages.
-    ALLOW_DIRECT_CLIENT_CALLS_FOR_SYNC_MESSAGES,
-    // Allow to call any InterfaceEndpointClient methods directly.
-    ALLOW_DIRECT_CLIENT_CALLS
-  };
-
   // Processes enqueued tasks (incoming messages and error notifications).
   // |current_task_runner| is only used when |client_call_behavior| is
   // ALLOW_DIRECT_CLIENT_CALLS to determine whether we are on the right task
   // runner to make client calls for async messages or connection error
   // notifications.
   //
   // Note: Because calling into InterfaceEndpointClient may lead to destruction
   // of this object, if direct calls are allowed, the caller needs to hold on to
   // a ref outside of |lock_| before calling this method.
   void ProcessTasks(ClientCallBehavior client_call_behavior,
@@ skipping 64 matching lines @@
 
   bool posted_to_process_tasks_;
   scoped_refptr<base::SingleThreadTaskRunner> posted_to_task_runner_;
 
   bool encountered_error_;
 
   bool paused_;
 
   bool testing_mode_;
 
+  ClientCallBehavior sync_client_call_behavior_;
+
   DISALLOW_COPY_AND_ASSIGN(MultiplexRouter);
 };
 
 }  // namespace internal
 }  // namespace mojo
 
 #endif  // MOJO_PUBLIC_CPP_BINDINGS_LIB_MULTIPLEX_ROUTER_H_