Blink-compatible serialization of ArrayBuffer transfer.

include/v8.h

 // Copyright 2012 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /** \mainpage V8 API Reference Guide
  *
  * V8 is Google's open source JavaScript engine.
  *
  * This set of documents provides reference material generated from the
  * V8 header file, include/v8.h.
@@ skipping 52 matching lines @@
 
 #endif  // V8_OS_WIN
 
 /**
  * The v8 JavaScript engine.
  */
 namespace v8 {
 
 class AccessorSignature;
 class Array;
+class ArrayBuffer;
 class Boolean;
 class BooleanObject;
 class Context;
 class CpuProfiler;
 class Data;
 class Date;
 class External;
 class Function;
 class FunctionTemplate;
 class HeapProfiler;
@@ skipping 1599 matching lines @@
    */
   V8_WARN_UNUSED_RESULT Maybe<bool> WriteValue(Local<Context> context,
                                                Local<Value> value);
 
   /*
    * Returns the stored data. This serializer should not be used once the buffer
    * is released. The contents are undefined if a previous write has failed.
    */
   std::vector<uint8_t> ReleaseBuffer();
 
+  /*
+   * Marks an ArrayBuffer as havings its contents transferred out of band.
+   * Pass the corresponding JSArrayBuffer in the deserializing context to
+   * ValueDeserializer::TransferArrayBuffer.
+   */
+  void TransferArrayBuffer(uint32_t transfer_id,
+                           Local<ArrayBuffer> array_buffer);
+
  private:
   ValueSerializer(const ValueSerializer&) = delete;
   void operator=(const ValueSerializer&) = delete;
 
   struct PrivateData;
   PrivateData* private_;
 };
 
 /**
  * Deserializes values from data written with ValueSerializer, or a compatible
@@ skipping 13 matching lines @@
    * May, for example, reject an invalid or unsupported wire format.
    */
   V8_WARN_UNUSED_RESULT Maybe<bool> ReadHeader();
 
   /*
    * Deserializes a JavaScript value from the buffer.
    */
   V8_WARN_UNUSED_RESULT MaybeLocal<Value> ReadValue(Local<Context> context);
 
   /*
+   * Provides the array buffer corresponding to the one passed previously to

[Jakob Kummerow, 2016/08/26 12:22:40]

nit: I find the word "Provides" misleading here, because as a caller of this
method /I/ have to provide the value, and this function consumes it. How about
"takes" or "accepts" or "registers" or some other term that indicates input
rather than output?

[jbroman, 2016/08/26 15:16:24]

Done.

+   * ValueSerializer::TransferArrayBuffer.
+   */
+  void TransferArrayBuffer(uint32_t transfer_id,
+                           Local<ArrayBuffer> array_buffer);
+
+  /*
    * Must be called before ReadHeader to enable support for reading the legacy
    * wire format (i.e., which predates this being shipped).
    *
    * Don't use this unless you need to read data written by previous versions of
    * blink::ScriptValueSerializer.
    */
   void SetSupportsLegacyWireFormat(bool supports_legacy_wire_format);
 
   /*
    * Reads the underlying wire format version. Likely mostly to be useful to
@@ skipping 7355 matching lines @@
  */
 
 
 }  // namespace v8
 
 
 #undef TYPE_CHECK
 
 
 #endif  // INCLUDE_V8_H_