corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1932961 - document ownership semantics of custom transferables r=aosmond

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D229978
This commit is contained in:
Steve Fink
2024-12-04 00:42:47 +00:00
parent 7280d01b9d
commit 3c90c98086
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
js/public/StructuredClone.h
View File

@@ -319,6 +319,11 @@ typedef void (*StructuredCloneErrorOp)(JSContext* cx, uint32_t errorid,
* If this readTransfer() hook is called and produces an object, then the * If this readTransfer() hook is called and produces an object, then the
* read() hook will *not* be called for the same object, since the main data * read() hook will *not* be called for the same object, since the main data
* will only contain a backreference to the already-read object. * will only contain a backreference to the already-read object.
*
* The clone buffer will relinquish ownership of this Transferable if and only
* if this hook returns true -- as in, the freeTransfer hook will not be called
* on this entry if this hook returns true, but it will still be called if it
* returns false.
*/ */
typedef bool (*ReadTransferStructuredCloneOp)( typedef bool (*ReadTransferStructuredCloneOp)(
JSContext* cx, JSStructuredCloneReader* r, JSContext* cx, JSStructuredCloneReader* r,
@@ -359,7 +364,9 @@ typedef bool (*TransferStructuredCloneOp)(JSContext* cx,
* encountered later and the incomplete serialization is discarded. * encountered later and the incomplete serialization is discarded.
* *
* 2. During deserialization: before an object is Transferred to, an error * 2. During deserialization: before an object is Transferred to, an error
* is encountered and the incompletely deserialized clone is discarded. * is encountered and the incompletely deserialized clone is discarded. This
* will happen with internally-implemented Transferables as well as those
* where the readTransfer hook returns false.
* *
* 3. Serialized data that includes Transferring is never deserialized (eg when * 3. Serialized data that includes Transferring is never deserialized (eg when
* the receiver disappears before reading in the message), and the clone data * the receiver disappears before reading in the message), and the clone data