netwerk/base/public/nsIThreadRetargetableStreamListener.idl@b8a032363ba2 (annotated)
netwerk/base/public/nsIThreadRetargetableStreamListener.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: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* vim: set ts=8 sts=2 et sw=2 tw=80: */ |
| michael@0 | 3 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #include "nsISupports.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * nsIThreadRetargetableStreamListener |
| michael@0 | 11 | * |
| michael@0 | 12 | * To be used by classes which implement nsIStreamListener and whose |
| michael@0 | 13 | * OnDataAvailable callback may be retargeted for delivery off the main thread. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [uuid(fb2304b8-f82f-4433-af68-d874a2ebbdc1)] |
| michael@0 | 16 | interface nsIThreadRetargetableStreamListener : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Checks this listener and any next listeners it may have to verify that |
| michael@0 | 20 | * they can receive OnDataAvailable off the main thread. It is the |
| michael@0 | 21 | * responsibility of the implementing class to decide on the criteria to |
| michael@0 | 22 | * determine if retargeted delivery of these methods is possible, but it must |
| michael@0 | 23 | * check any and all nsIStreamListener objects that might be called in the |
| michael@0 | 24 | * listener chain. |
| michael@0 | 25 | * |
| michael@0 | 26 | * An exception should be thrown if a listener in the chain does not |
| michael@0 | 27 | * support retargeted delivery, i.e. if the next listener does not implement |
| michael@0 | 28 | * nsIThreadRetargetableStreamListener, or a call to its checkListenerChain() |
| michael@0 | 29 | * fails. |
| michael@0 | 30 | */ |
| michael@0 | 31 | void checkListenerChain(); |
| michael@0 | 32 | }; |
| michael@0 | 33 |
