netwerk/base/public/nsIAsyncStreamCopier.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Darin Fisher <darin@netscape.com>
  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 "nsIRequest.idl"
  39
  40 interface nsIInputStream;
  41 interface nsIOutputStream;
  42 interface nsIRequestObserver;
  43 interface nsIEventTarget;
  44
  45 [scriptable, uuid(72e515de-a91e-4154-bb78-e5244cbaae74)]
  46 interface nsIAsyncStreamCopier : nsIRequest
  47 {
  48     /**
  49      * Initialize the stream copier.
  50      *
  51      * @param aSource
  52      *        contains the data to be copied.
  53      * @param aSink
  54      *        specifies the destination for the data.
  55      * @param aTarget
  56      *        specifies the thread on which the copy will occur.  a null value
  57      *        is permitted and will cause the copy to occur on an unspecified
  58      *        background thread.
  59      * @param aSourceBuffered
  60      *        true if aSource implements ReadSegments.
  61      * @param aSinkBuffered
  62      *        true if aSink implements WriteSegments.
  63      * @param aChunkSize
  64      *        specifies how many bytes to read/write at a time.  this controls
  65      *        the granularity of the copying.  it should match the segment size
  66      *        of the "buffered" streams involved.
  67      *
  68      * NOTE: at least one of the streams must be buffered.
  69      */
  70     void init(in nsIInputStream    aSource,
  71               in nsIOutputStream   aSink,
  72               in nsIEventTarget    aTarget,
  73               in boolean           aSourceBuffered,
  74               in boolean           aSinkBuffered,
  75               in unsigned long     aChunkSize);
  76
  77     /**
  78      * asyncCopy triggers the start of the copy.  The observer will be notified
  79      * when the copy completes.
  80      *
  81      * @param aObserver
  82      *        receives notifications.
  83      * @param aObserverContext
  84      *        passed to observer methods.
  85      */
  86     void asyncCopy(in nsIRequestObserver   aObserver,
  87                    in nsISupports          aObserverContext);
  88 };