← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/netwerk/base/public/nsIStreamListener.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/netwerk/base/public/nsIStreamListener.idl
 
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
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 NPL, 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 NPL, the GPL or the LGPL.
 
35
 *
 
36
 * ***** END LICENSE BLOCK ***** */
 
37
 
 
38
#include "nsIRequestObserver.idl"
 
39
 
 
40
interface nsIInputStream;
 
41
 
 
42
/**
 
43
 * nsIStreamListener
 
44
 *
 
45
 * @status FROZEN
 
46
 */
 
47
[scriptable, uuid(1a637020-1482-11d3-9333-00104ba0fd40)]
 
48
interface nsIStreamListener : nsIRequestObserver
 
49
{
 
50
    /**
 
51
     * Called when the next chunk of data (corresponding to the request) may
 
52
     * be read without blocking the calling thread.  The onDataAvailable impl
 
53
     * must read exactly |aCount| bytes of data before returning.
 
54
     *
 
55
     * @param aRequest request corresponding to the source of the data
 
56
     * @param aContext user defined context
 
57
     * @param aInputStream input stream containing the data chunk
 
58
     * @param aOffset current stream position
 
59
     * @param aCount number of bytes available in the stream
 
60
     *
 
61
     * An exception thrown from onDataAvailable has the side-effect of
 
62
     * causing the request to be canceled.
 
63
     */
 
64
    void onDataAvailable(in nsIRequest aRequest,
 
65
                         in nsISupports aContext, 
 
66
                         in nsIInputStream aInputStream,
 
67
                         in unsigned long aOffset,
 
68
                         in unsigned long aCount);
 
69
};