Changes between Version 67 and Version 68 of WebKitIDL

Timestamp:

Mar 27, 2012 4:07:42 PM (12 years ago)

Author:

abarth@webkit.org

Comment:

--

WebKitIDL

@@ -45 +45 @@
  - [#CustomEnumerateProperty CustomEnumerateProperty(i), CustomDeleteProperty(i)][[br]]
  - [#IsWorkerContext IsWorkerContext(i)][[br]]
+ - [#TransferList TransferList(p)][[br]]
  - [#CustomCall CustomCall(i)][[br]]
  - [#JSCustomToNativeObject JSCustomToNativeObject(i), JSCustomFinalize(i), JSCustomIsReachable(i), JSCustomMarkFunction(i), JSCustomNamedGetterOnPrototype(i), JSCustomPushEventHandlerScope(i), JSCustomDefineOwnProperty(i), JSCustomDefineOwnPropertyOnPrototype(i), JSCustomGetOwnPropertySlotAndDescriptor(i)][[br]]
@@ -1426 +1427 @@
 }}}
 
+== [TransferList](p) == #TransferList
+
+Summary: [TransferList] allows a SerializedScriptValue parameter used
+with the structured clone algorithm to specify another parameter used
+to pass the transfer list.
+
+Usage: The possible usage is [TransferList=XXX] where XXX is another
+parameter in the same method signature as the SerializedScriptValue
+parameter on which the modifier is placed. The referenced parameter
+should be of type "Array" to be compatible with the Web Messaging
+standard.
+
+When this modifier is used, the code generation automatically creates
+a MessagePortArray and completes the structured clone algorithm using
+the input data from the JavaScript caller. The resulting
+MessagePortArray is then passed to the implementation's method
+signature in place of the Array parameter referenced.
+
+Example:
+{{{
+    interface Worker {
+        void postMessage(in [TransferList=transfer] SerializedScriptValue data, in [Optional=DefaultIsUndefined] Array transfer);
+    }
+}}}
+And in the implementation:
+{{{
+    class Worker {
+        virtual void postMessage(PassRefPtr<SerializedScriptValue> data, const MessagePortArray& ports);
+    }
+}}}
+
 == [CustomCall](i) == #CustomCall