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

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

mercurial