netwerk/base/public/nsIUnicharStreamListener.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is mozilla.org.
  18  * Portions created by the Initial Developer are Copyright (C) 2004
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Johnny Stenback <jst@mozilla.org>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsIRequestObserver.idl"
  39
  40 /**
  41  * nsIUnicharStreamListener is very similar to nsIStreamListener with
  42  * the difference being that this interface gives notifications about
  43  * data being available after the raw data has been converted to
  44  * UTF-16.
  45  *
  46  * nsIUnicharStreamListener
  47  *
  48  * @status FROZEN
  49  */
  50 [scriptable, uuid(4a7e9b62-fef8-400d-9865-d6820f630b4c)]
  51 interface nsIUnicharStreamListener : nsIRequestObserver
  52 {
  53     /**
  54      * Called when the next chunk of data (corresponding to the
  55      * request) is available.
  56      *
  57      * @param aRequest request corresponding to the source of the data
  58      * @param aContext user defined context
  59      * @param aData the data chunk
  60      *
  61      * An exception thrown from onUnicharDataAvailable has the
  62      * side-effect of causing the request to be canceled.
  63      */
  64     void onUnicharDataAvailable(in nsIRequest aRequest,
  65                                 in nsISupports aContext, in AString aData);
  66 };