DomStorage async IPC message definitions and browser-side handlers. These messages aren't called ye…

content/common/dom_storage_messages.h

 // 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.
 
 // Multiply-included message file, no traditional include guard.
 #include "content/public/common/common_param_traits.h"
 #include "googleurl/src/gurl.h"
 #include "ipc/ipc_message_macros.h"
 #include "ipc/ipc_param_traits.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebStorageArea.h"
@@ skipping 20 matching lines @@
 
   // The non-zero connection_id which caused the event or 0 if the event
   // was not caused by the target renderer process.
   IPC_STRUCT_MEMBER(int, connection_id)
 IPC_STRUCT_END()
 
 IPC_ENUM_TRAITS(WebKit::WebStorageArea::Result)
 
 // DOM Storage messages sent from the browser to the renderer.
 
-// Storage events are broadcast to renderer processes.
+// Storage events are broadcast to all renderer processes.
 IPC_MESSAGE_CONTROL1(DOMStorageMsg_Event,
                      DOMStorageMsg_Event_Params)
 
+// Completion notification sent in response to each async
+// set, remove, and clear operation. Used to maintain the integrity
+// of the renderer-side cache.
+IPC_MESSAGE_CONTROL2(DOMStorageHostMsg_AsyncOperationComplete,
+                     int /* operation_id */,
+                     bool /* success */)
 
 // DOM Storage messages sent from the renderer to the browser.
 // Note: The 'connection_id' must be the first parameter in these message.
 
 // Open the storage area for a particular origin within a namespace.
 IPC_MESSAGE_CONTROL3(DOMStorageHostMsg_OpenStorageArea,
-                            int /* connection_id */,
-                            int64 /* namespace_id */,
-                            GURL /* origin */)
+                     int /* connection_id */,
+                     int64 /* namespace_id */,
+                     GURL /* origin */)
 
 // Close a previously opened storage area.
 IPC_MESSAGE_CONTROL1(DOMStorageHostMsg_CloseStorageArea,
                      int /* connection_id */)
 
+// Retrieves the set of key/value pairs for the area. Used to prime
+// the renderer-side cache.
+IPC_SYNC_MESSAGE_CONTROL1_1(DOMStorageHostMsg_LoadStorageArea,
+                            int /* connection_id */,
+                            dom_storage::ValuesMap)
+
 // Get the length of a storage area.
 IPC_SYNC_MESSAGE_CONTROL1_1(DOMStorageHostMsg_Length,
                             int /* connection_id */,
                             unsigned /* length */)
 
 // Get a the ith key within a storage area.
 IPC_SYNC_MESSAGE_CONTROL2_1(DOMStorageHostMsg_Key,
                             int /* connection_id */,
                             unsigned /* index */,
                             NullableString16 /* key */)
 
 // Get a value based on a key from a storage area.
 IPC_SYNC_MESSAGE_CONTROL2_1(DOMStorageHostMsg_GetItem,
                             int /* connection_id */,
                             string16 /* key */,
                             NullableString16 /* value */)
 
+// TODO(michaeln): after the old sync IPC message have been deleted,
+// rename the Async ones to no longer have the Async suffix.
+
 // Set a value that's associated with a key in a storage area.
 IPC_SYNC_MESSAGE_CONTROL4_2(DOMStorageHostMsg_SetItem,
                             int /* connection_id */,
                             string16 /* key */,
                             string16 /* value */,
                             GURL /* page_url */,
                             WebKit::WebStorageArea::Result /* result */,
                             NullableString16 /* old_value */)
 
+// Set a value that's associated with a key in a storage area.
+// A completion notification is sent in response.
+IPC_MESSAGE_CONTROL5(DOMStorageHostMsg_SetItemAsync,
+                     int /* connection_id */,
+                     int /* operation_id */,
+                     string16 /* key */,
+                     string16 /* value */,
+                     GURL /* page_url */)
+
 // Remove the value associated with a key in a storage area.
 IPC_SYNC_MESSAGE_CONTROL3_1(DOMStorageHostMsg_RemoveItem,
                             int /* connection_id */,
                             string16 /* key */,
                             GURL /* page_url */,
                             NullableString16 /* old_value */)
 
+// Remove the value associated with a key in a storage area.
+// A completion notification is sent in response.
+IPC_MESSAGE_CONTROL4(DOMStorageHostMsg_RemoveItemAsync,
+                     int /* connection_id */,
+                     int /* operation_id */,
+                     string16 /* key */,
+                     GURL /* page_url */)
+
 // Clear the storage area.
 IPC_SYNC_MESSAGE_CONTROL2_1(DOMStorageHostMsg_Clear,
                             int /* connection_id */,
                             GURL /* page_url */,
                             bool /* something_cleared */)
 
+// Clear the storage area. A completion notification is sent in response.
+IPC_MESSAGE_CONTROL3(DOMStorageHostMsg_ClearAsync,
+                     int /* connection_id */,
+                     int /* operation_id */,
+                     GURL /* page_url */)