xpcom/io/nsIObjectInputStream.idl@6474c204b198 (annotated)
xpcom/io/nsIObjectInputStream.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsIBinaryInputStream.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | /** |
| michael@0 | 9 | * @see nsIObjectOutputStream |
| michael@0 | 10 | * @see nsIBinaryInputStream |
| michael@0 | 11 | */ |
| michael@0 | 12 | |
| michael@0 | 13 | [scriptable, uuid(6c248606-4eae-46fa-9df0-ba58502368eb)] |
| michael@0 | 14 | interface nsIObjectInputStream : nsIBinaryInputStream |
| michael@0 | 15 | { |
| michael@0 | 16 | /** |
| michael@0 | 17 | * Read an object from this stream to satisfy a strong or weak reference |
| michael@0 | 18 | * to one of its interfaces. If the interface was not along the primary |
| michael@0 | 19 | * inheritance chain ending in the "root" or XPCOM-identity nsISupports, |
| michael@0 | 20 | * readObject will QueryInterface from the deserialized object root to the |
| michael@0 | 21 | * correct interface, which was specified when the object was serialized. |
| michael@0 | 22 | * |
| michael@0 | 23 | * @see nsIObjectOutputStream |
| michael@0 | 24 | */ |
| michael@0 | 25 | nsISupports readObject(in boolean aIsStrongRef); |
| michael@0 | 26 | |
| michael@0 | 27 | [notxpcom] nsresult readID(out nsID aID); |
| michael@0 | 28 | |
| michael@0 | 29 | /** |
| michael@0 | 30 | * Optimized deserialization support -- see nsIStreamBufferAccess.idl. |
| michael@0 | 31 | */ |
| michael@0 | 32 | [notxpcom] charPtr getBuffer(in uint32_t aLength, in uint32_t aAlignMask); |
| michael@0 | 33 | [notxpcom] void putBuffer(in charPtr aBuffer, in uint32_t aLength); |
| michael@0 | 34 | }; |
| michael@0 | 35 | |
| michael@0 | 36 | %{C++ |
| michael@0 | 37 | |
| michael@0 | 38 | inline nsresult |
| michael@0 | 39 | NS_ReadOptionalObject(nsIObjectInputStream* aStream, bool aIsStrongRef, |
| michael@0 | 40 | nsISupports* *aResult) |
| michael@0 | 41 | { |
| michael@0 | 42 | bool nonnull; |
| michael@0 | 43 | nsresult rv = aStream->ReadBoolean(&nonnull); |
| michael@0 | 44 | if (NS_SUCCEEDED(rv)) { |
| michael@0 | 45 | if (nonnull) |
| michael@0 | 46 | rv = aStream->ReadObject(aIsStrongRef, aResult); |
| michael@0 | 47 | else |
| michael@0 | 48 | *aResult = nullptr; |
| michael@0 | 49 | } |
| michael@0 | 50 | return rv; |
| michael@0 | 51 | } |
| michael@0 | 52 | |
| michael@0 | 53 | %} |
