| /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 1998 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsIRequestObserver.idl" |
| |
| interface nsIInputStream; |
| |
| /** |
| * nsIStreamListener |
| * |
| * @status FROZEN |
| */ |
| [scriptable, uuid(1a637020-1482-11d3-9333-00104ba0fd40)] |
| interface nsIStreamListener : nsIRequestObserver |
| { |
| /** |
| * Called when the next chunk of data (corresponding to the request) may |
| * be read without blocking the calling thread. The onDataAvailable impl |
| * must read exactly |aCount| bytes of data before returning. |
| * |
| * @param aRequest request corresponding to the source of the data |
| * @param aContext user defined context |
| * @param aInputStream input stream containing the data chunk |
| * @param aOffset |
| * Number of bytes that were sent in previous onDataAvailable calls |
| * for this request. In other words, the sum of all previous count |
| * parameters. |
| * If that number is greater than or equal to 2^32, this parameter |
| * will be PR_UINT32_MAX (2^32 - 1). |
| * @param aCount number of bytes available in the stream |
| * |
| * NOTE: The aInputStream parameter must implement readSegments. |
| * |
| * An exception thrown from onDataAvailable has the side-effect of |
| * causing the request to be canceled. |
| */ |
| void onDataAvailable(in nsIRequest aRequest, |
| in nsISupports aContext, |
| in nsIInputStream aInputStream, |
| in unsigned long aOffset, |
| in unsigned long aCount); |
| }; |