netwerk/base/public/nsIEncodedChannel.idl@b8a032363ba2 (annotated)
netwerk/base/public/nsIEncodedChannel.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| 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 "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIUTF8StringEnumerator; |
| michael@0 | 9 | /** |
| michael@0 | 10 | * A channel interface which allows special handling of encoded content |
| michael@0 | 11 | */ |
| michael@0 | 12 | |
| michael@0 | 13 | [scriptable, uuid(30d7ec3a-f376-4652-9276-3092ec57abb6)] |
| michael@0 | 14 | interface nsIEncodedChannel : nsISupports |
| michael@0 | 15 | { |
| michael@0 | 16 | /** |
| michael@0 | 17 | * This attribute holds the MIME types corresponding to the content |
| michael@0 | 18 | * encodings on the channel. The enumerator returns nsISupportsCString |
| michael@0 | 19 | * objects. The first one corresponds to the outermost encoding on the |
| michael@0 | 20 | * channel and then we work our way inward. "identity" is skipped and not |
| michael@0 | 21 | * represented on the list. Unknown encodings make the enumeration stop. |
| michael@0 | 22 | * If you want the actual Content-Encoding value, use |
| michael@0 | 23 | * getResponseHeader("Content-Encoding"). |
| michael@0 | 24 | * |
| michael@0 | 25 | * When there is no Content-Encoding header, this property is null. |
| michael@0 | 26 | * |
| michael@0 | 27 | * Modifying the Content-Encoding header on the channel will cause |
| michael@0 | 28 | * this enumerator to have undefined behavior. Don't do it. |
| michael@0 | 29 | * |
| michael@0 | 30 | * Also note that contentEncodings only exist during or after OnStartRequest. |
| michael@0 | 31 | * Calling contentEncodings before OnStartRequest is an error. |
| michael@0 | 32 | */ |
| michael@0 | 33 | readonly attribute nsIUTF8StringEnumerator contentEncodings; |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * This attribute controls whether or not content conversion should be |
| michael@0 | 37 | * done per the Content-Encoding response header. applyConversion can only |
| michael@0 | 38 | * be set before or during OnStartRequest. Calling this during |
| michael@0 | 39 | * OnDataAvailable is an error. |
| michael@0 | 40 | * |
| michael@0 | 41 | * TRUE by default. |
| michael@0 | 42 | */ |
| michael@0 | 43 | attribute boolean applyConversion; |
| michael@0 | 44 | }; |
