netwerk/base/nsIThreadRetargetableStreamListener.idl
author James Kitchener <jkitch.bug@internode.on.net>
Tue, 20 Jan 2015 03:58:00 -0500
changeset 224865 4ec37503ea6a752baf92e053ede5f0ff7750ff36
parent 137700 netwerk/base/public/nsIThreadRetargetableStreamListener.idl@57ffaa460a6bb8f0507f119a4b5b62e0c430d99a
permissions -rw-r--r--
Bug 1100184 - Flatten netwerk/base/{public,src}/ directories. r=mcmanus, r=poiru

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

/**
 * nsIThreadRetargetableStreamListener
 *
 * To be used by classes which implement nsIStreamListener and whose
 * OnDataAvailable callback may be retargeted for delivery off the main thread.
 */
[uuid(fb2304b8-f82f-4433-af68-d874a2ebbdc1)]
interface nsIThreadRetargetableStreamListener : nsISupports
{
  /**
   * Checks this listener and any next listeners it may have to verify that
   * they can receive OnDataAvailable off the main thread. It is the
   * responsibility of the implementing class to decide on the criteria to
   * determine if retargeted delivery of these methods is possible, but it must
   * check any and all nsIStreamListener objects that might be called in the
   * listener chain.
   *
   * An exception should be thrown if a listener in the chain does not
   * support retargeted delivery, i.e. if the next listener does not implement
   * nsIThreadRetargetableStreamListener, or a call to its checkListenerChain()
   * fails.
   */
  void checkListenerChain();
};